Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Instances

Get
GET /surveymodules/{moduleId}/surveys/{surveyId}/instances/{instanceId} 
https://api.relesysapp.net/api/v1.3/surveymodules/{moduleId}/surveys/{surveyId}/instances/{instanceId}
Get a survey instance with ID instanceId.
More information about statuses can be found in Surveys -> List documentation. totalUsers - Number of users that have access to the survey.
participationPercentage - Percentage of participants who had access to the survey that responded.
Scopes: relesys.api, relesys.api:read, relesys.api.survey, relesys.api.survey:read
URL Path
moduleId string / guid The module's unique identifier required
surveyId string / guid The survey's unique identifier required
instanceId string / guid The survey instance's unique identifier required
Responses
application/json
200
Schema Example
JSON
{"data":{"id":"38968f2b-eeda-4947-ae76-aa8922b39309","name":"Product Feedback Survey","status":"Published","availableFrom":"2025-10-16T03:21:11","availableFromTimeZone":null,"availableUntil":"2025-10-17T03:21:11","availableUntilTimeZone":null,"totalUsers":150,"participationPercentage":null,"locales":[{"culture":"en-US","title":"Product Feedback Survey"},{"culture":"da-DK","title":"Produktfeedbackundersøgelse"}],"creationDateTime":"2025-10-14T03:21:11.3529988+00:00","lastModifiedDateTime":null}}
object
  ⯈ data object      
   availableFrom string      
   availableFromTimeZone string      
   availableUntil string      
   availableUntilTimeZone string      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   name string      
   participationPercentage double      
   status string      
   totalUsers integer