Scale API | Questions › List Questions

Questions

questions

Methods

Create Question ->

Question

post/v4/questions

Description

Creates a question

Details

This API can be used to create a question. To use this API, review the request schema and pass in all fields that are required to create a question.

List Questions -> PageResponse<

Question

get/v4/questions

Description

Lists all questions accessible to the user.

Details

This API can be used to list questions. If a user has access to multiple accounts, all questions from all accounts the user is associated with will be returned.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

limit: number

Optional

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

page: number

Optional

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

Response fields

PaginatedQuestions

Request example

curl https://api.egp.scale.com/v4/questions \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "prompt": "prompt",
      "title": "title",
      "type": "categorical",
      "choices": [
        {
          "label": "label",
          "value": "string",
          "audit_required": true
        }
      ],
      "conditions": [
        {}
      ],
      "dropdown": true,
      "multi": true,
      "numberOptions": {
        "max": 0,
        "min": 0
      },
      "ratingOptions": {
        "maxLabel": "maxLabel",
        "minLabel": "minLabel",
        "scaleSteps": 0
      },
      "required": true
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Question ->

Question

get/v4/questions/{question_id}

Description

Gets the details of a question

Details

This API can be used to get information about a single question by ID. To use this API, pass in the id that was returned from your Create Question API call as a path parameter.

Review the response schema to see the fields that will be returned.

Domain types

PaginatedQuestions = { current_page, items, items_per_page, 1 more... }

Question = { id, account_id, created_at, 11 more... }