GET
/
v4
/
question-sets
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() {
  // Automatically fetches more pages as needed.
  for await (const questionSet of client.questionSets.list()) {
    console.log(questionSet.id);
  }
}

main();
{
  "items": [
    {
      "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>"
        }
      ],
      "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"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Query Parameters

view
enum<string>[] | null
Available options:
Questions
page
integer
default:
1

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

Required range: x > 1
limit
integer
default:
100

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

Required range: 1 < x < 10000
account_id
string | null
include_archived
boolean
default:
false

Response

200
application/json
Successful Response
items
object[]
required

The data returned for the current page.

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.