GET
/
v4
/
questions
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const question of client.questions.list()) {
  console.log(question.id);
}
{
  "items": [
    {
      "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>",
      "form_schema": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "created_by_identity_type": "user"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string

Query Parameters

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

Response

200
application/json

Successful Response

The response is of type object.