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
});

const questionSetWithQuestions = await client.questionSets.retrieve('question_set_id');

console.log(questionSetWithQuestions.id);
{
  "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
      },
      "freeTextOptions": {
        "characterLimit": {
          "min": 50,
          "max": 1000
        }
      },
      "multi": true,
      "dropdown": true,
      "required": true,
      "conditions": [
        {}
      ],
      "default": "<any>",
      "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

The response is of type object.