Tool
support_survey_get
Get one survey by id, with its whole question set.
Get one survey by id, with its whole question set. A survey belonging to another product is reported as not found. Through the public edge only a PUBLISHED survey is readable — a draft or an archived one is reported as not found there
Behavior
- HTTP
GET /support/surveys/:id
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | • | Survey id |
Response
Field | Type | Always | Description |
|---|---|---|---|
id | string | • | Survey id |
name | string | • | What this survey is called |
status | string | • | draft: editable, not answerable. published: answerable, frozen. archived: terminal, neither editable nor answerable, and there is no way back |
createdAt | string | • | ISO-8601 creation timestamp |
questions | array | • | The ordered question set, exactly as stored |
updatedAt | string | • | ISO-8601 last-modification timestamp |
questionIds | array | • | The same questions as a flat list of ids, in the order they are asked |
questionCount | integer | • | How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape |
Try it
Get one survey by id, with its whole question set.