For the complete documentation index, see llms.txt. This page is also available as Markdown.

Survey Definitions by Season

Overview

Returns the guest survey definitions configured for a season — the surveys themselves, plus the questions that make up each survey. Use this when you need to know what surveys exist and what they ask.

Heads up — two "surveys" endpoints

flaik Connect exposes two different survey-related endpoints. They return different things:

  • Survey Definitions (this page, /api/globalsettings/surveys/{seasonId}) — survey configuration for a season: titles, questions, hints. Use this to model surveys in your system.

  • Class Survey Responses (/api/classmanagement/surveys/{startDate}/{endDate}) — survey responses captured against classes. Use this to ingest the answers guests have given.

Authentication

Include your access token in the Authorization header:

Authorization: Bearer {access_token}

See the Authentication Guide for details on obtaining access tokens.

Endpoint

GET {api-url}/api/globalsettings/surveys/{seasonId}

Path Parameters

Parameter
Type
Required
Description

seasonId

integer

Yes

Season identifier — retrieve from the Seasons endpoint

Query Parameters

None.

Example Request

Response Format

Response Fields — Survey

Each item in the top-level array represents a single survey definition.

Field
Type
Description

id

integer

Unique survey identifier

title

string

Survey display title

status

integer

Survey lifecycle status — see Status Values below

questions

array

The questions that make up this survey, in display order

Response Fields — Question

Field
Type
Description

questionId

integer

Unique question identifier

questionText

string

The question shown to the guest

status

integer

Question lifecycle status — see Status Values below

orderHint

integer

Suggested display order within the survey (lower numbers first)

minHint

string

Label shown next to the lowest end of a rating scale (e.g. "Very poor")

midHint

string

Label shown at the midpoint of a rating scale

maxHint

string

Label shown next to the highest end of a rating scale

Status Values

Both status fields use the same set of values:

Value
Meaning

1

Active

2

Inactive

Surveys and questions can be marked inactive without being deleted. Filter on status: 1 if you only want what's currently in use.

Error Responses

HTTP Status
Description

400

The supplied seasonId does not exist for this resort

401

Missing or invalid access token

Need help with survey configuration? Contact resortsupport@flaik.com.

Last updated

Was this helpful?