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

List
GET /surveymodules/{moduleId}/surveys/{surveyId}/instances 
https://api.relesysapp.net/api/v1.3/surveymodules/{moduleId}/surveys/{surveyId}/instances
Get survey instances for a survey with ID surveyId.
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
Query String
availableFrom datetime Filterable Sortable optional
availableUntil datetime Filterable Sortable optional
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name string Filterable Sortable optional
surveyId string / guid Filterable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"4a965f88-545d-4388-8c4a-5fecb35ebcb9","name":"Product Feedback Survey","status":"Published","availableFrom":"2025-11-05T12:25:47","availableFromTimeZone":null,"availableUntil":"2025-11-06T12:25:47","availableUntilTimeZone":null,"totalUsers":150,"participationPercentage":null,"locales":[{"culture":"en-US","title":"Product Feedback Survey"},{"culture":"da-DK","title":"Produktfeedbackundersøgelse"}],"creationDateTime":"2025-11-03T12:25:47.8308427+00:00","lastModifiedDateTime":null},{"id":"6a070485-70f0-44ef-a7b3-fd5b78184b21","name":"Employee Engagement Survey","status":"Published","availableFrom":"2025-11-05T12:25:47","availableFromTimeZone":"UTC","availableUntil":"2025-11-06T12:25:47","availableUntilTimeZone":"UTC","totalUsers":150,"participationPercentage":75.5,"locales":[{"culture":"da-DK","title":"Produktfeedbackundersøgelse"}],"creationDateTime":"2025-10-26T12:25:47.8308427+00:00","lastModifiedDateTime":"2025-11-05T12:25:47.8308427+00:00"}]}
object
  count integer      
  ⯈ data array[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      
  nextUrl string      
  previousUrl string