Documentation | Questions › List Questions

API Reference

Questions

questions

Methods

Create Question ->

Question

post/v5/questions

Create Question

List Questions -> CursorPage<

Question

get/v5/questions

List Questions

query Parameters

ending_before: string

Optional

limit: number

Optional

(maximum: 1000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

Question

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

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

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "configuration": {
        "choices": [
          "string"
        ],
        "dropdown": true,
        "multi": true
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "name": "name",
      "prompt": "prompt",
      "conditions": [
        {
          "foo": "bar"
        }
      ],
      "object": "question",
      "question_type": "categorical"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Get Question ->

Question

get/v5/questions/{question_id}

Get Question

Domain types

Question = { id, configuration, created_at, 6 more... } | { id, configuration, created_at, 6 more... } | { id, created_at, created_by, 6 more... } | 3 more...