Game Loom
  1. Survey
Game Loom
  • Game Loom
    • 👋 Welcome to Game Loom
  • Getting started
    • Introduction
    • 👤 Authentication
  • User Registration
    • Introduction
    • Single user registration
      POST
    • Bulk Register Users
      POST
  • Notifications
    • Overview
    • Receiving Event Notifications via Webhooks
    • Get All notifications for specific user
      GET
  • Rewards
    • Overview
    • Points
      • Record user point event
      • Get user points
      • Get Specific user point
    • Levels
      • Record user level event
      • Get user levels
      • Get Specific user level
    • Badges
      • Award badge to user
      • Get user badges
      • Get Specific user badge
  • Challenges (Gamification elements)
    • Introduction
    • Leaderboard
      • Get available leaderboards for user
      • Submit score to a leaderboard
      • Get user's leaderboard participation history
      • Get leaderboard details
      • Get leaderboard ranking
      • Get user's record for a leaderboard
      • Get user's entry history for a leaderboard
    • Survey
      • Overview
      • Get available surveys for user
        GET
      • Start a new survey participation
        POST
      • Get detailed user participation
        GET
      • Get user's survey participation history
        GET
      • Abandon survey participation
        DELETE
      • Save individual answer to survey question
        POST
      • Submit completed survey
        PUT
      • Submit Survey with answers (One-Step Submission)
        POST
    • Open Challenge
      • Overview
      • Get available open challenges for user
      • Complete an open challenge
      • Get user's open challenge participation history
      • Get user open challenge by ID
    • Schemas
      • Survey Schame
  1. Survey

Get available surveys for user

GET
api/v1/user/{userkey}/surveys

Get Available Surveys for Participation#

Retrieves all surveys currently available for the authenticated user to participate in, with optional localization support.
This endpoint returns only surveys that the user has not yet participated in and that are currently eligible for participation based on targeting rules, availability dates, and survey configuration.

Behavior & Rules#

Only available and active surveys are returned.
Surveys that the user has already participated in will not appear in this response.
To retrieve details of a survey the user has already participated in, use the Get detailed user participation

Participation-Related Fields#

Some fields in the response are related to user participation metadata, for example:
{
  "id": "00000000-0000-0000-0000-000000000000",
  "userKey": null,
  "startedAt": "0001-01-01T00:00:00",
  "completedAt": null,
  "updatedDate": "0001-01-01T00:00:00",
  "createdDate": "0001-01-01T00:00:00"
}

Important Clarification#

These fields do not represent an active participation
They are placeholders returned for structural consistency
Actual participation values will be initialized and populated only after calling the
Start Survey Participation endpoint:
Start a new survey participation
Once participation is started:
A real participation id will be generated
userKey will be assigned
startedAt will be set to the participation start timestamp
Other fields will update as the survey progresses

Summary#

This endpoint allows clients to:
Discover surveys available for participation
Prevent duplicate participations
Maintain a clean separation between survey discovery and survey participation lifecycle

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'api/v1/user/{{user-key}}/surveys' \
--header 'x-api-key: {{api-key}}'
Response Response Example
[
    {
        "id": "string",
        "surveyId": "string",
        "userKey": "string",
        "companyId": "string",
        "status": 0,
        "startedAt": "string",
        "completedAt": "string",
        "updatedDate": "string",
        "createdDate": "string",
        "surveyName": "string",
        "surveyDescription": "string",
        "surveyStartDate": "string",
        "surveyEndDate": "string",
        "totalQuestions": 0,
        "answeredQuestions": 0,
        "progressPercentage": 0,
        "questions": [
            {
                "id": "string",
                "surveyId": "string",
                "questionType": 0,
                "question": "string",
                "orderQuestion": 0,
                "choices": [
                    "string"
                ],
                "createdDate": "string",
                "updatedDate": "string",
                "localizedQuestions": {
                    "ar": "string",
                    "en": "string"
                },
                "localizedChoices": {
                    "ar": [
                        "string"
                    ],
                    "en": [
                        "string"
                    ]
                }
            }
        ],
        "answers": [
            {
                "id": "string",
                "questionId": "string",
                "question": "string",
                "answer": "string",
                "answeredAt": "string"
            }
        ]
    }
]
Modified at 2025-12-23 22:08:22
Previous
Overview
Next
Start a new survey participation
Built with