GET
/
v4
/
question-sets
/
{question_set_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const questionSetWithQuestions = await client.questionSets.retrieve('question_set_id');

  console.log(questionSetWithQuestions.id);
}

main();
{
  "name": "<string>",
  "question_id_to_config": {},
  "instructions": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "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",
      "account_id": "<string>",
      "created_by_user_id": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
question_set_id
string
required

Response

200
application/json
Successful Response
​
name
string
required
​
id
string
required

The unique identifier of the entity.

​
created_at
string
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.

​
questions
object[]
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

​
archived_at
string

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

Get organizationDelete Question Set