Skip to main content
GET
Get one SurveyQuestion
A survey question (SurveyQuestion) is an ordered question within a location’s customer survey. It defines the customer-facing label, explanation, input type, optional choices, and whether the question is shown.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the SurveyQuestion-Read role.

Path Parameters

integer
required
The Id of the SurveyQuestion record to retrieve.

Code Examples

Response

200

integer
ID of the survey that contains this question; the survey’s location determines access to the question.
string
Display value for Survey.Name..
string
Required question label shown to customers.
string
Required explanatory text shown below the question to customers.
string
Comma-separated choices for a Dropdown question; leave empty for other question types.
boolean
Whether this question appears in the customer-facing survey.
integer
Integer position for displaying this question; lower values appear first and the system renumbers questions after create or update.
boolean
Whether customers can select more than one choice for a Dropdown question.
integer
Controls the customer input: Text, Boolean (Yes/No), LongText, Date, Dropdown, or Binary file upload; defaults to Text. See eQuestionType enum values: 1 = Text, 2 = Boolean, 3 = LongText, 4 = Date, 5 = Dropdown, 6 = Binary.
integer
Unique record identifier.
string
UUID of the record.
string
Date and time the record was created (ISO 8601).
string
Date and time the record was last updated (ISO 8601).
string
Email of the user who last updated this record.
boolean
Whether the record was recently created.
string
External system identifier.
Example Response