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

Surveys

List
GET /surveymodules/{moduleId}/surveys 
https://api.relesysapp.net/api/v1.3/surveymodules/{moduleId}/surveys
Get a list of surveys in a module with ID moduleId.
Default sort is by creationDateTime in descending order.

status - This field displays the status of the survey. Currently, the available statuses to filter on are:
  • Published
  • Published - Expired
  • Published - Awaiting
  • Unpublished

Scopes: relesys.api, relesys.api:read, relesys.api.survey, relesys.api.survey:read
URL Path
moduleId string / guid The module'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
status surveyinstancestatus Filterable Sortable 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":"114c7700-3188-49f6-8605-580d1e5e255b","name":"Annual Employee Survey","status":"Published","availableFrom":"2025-10-16T03:03:36","availableFromTimeZone":"","availableUntil":"2025-10-17T03:03:36","availableUntilTimeZone":"","anonymityEnabled":true,"isTracking":false,"locales":[{"culture":"en-US","title":"Annual Employee Survey"},{"culture":"da-DK","title":"Årlig medarbejderundersøgelse"}],"permissions":[{"departments":[{"url":null,"name":"Department name example","id":"7ed3cd86-dae9-4013-adb4-f327efe7f11c"}],"userGroups":[{"url":null,"name":"User group name example","id":"f3a19a97-6674-431a-b5d2-1a648cddb8d0"}],"requireAllUserGroups":false}],"creationDateTime":"2025-10-15T03:03:36.7964873+00:00","lastModifiedDateTime":"2025-10-16T03:03:36.7964873+00:00"},{"id":"dcbb8de0-3989-491d-aa39-0df7aeda4b6d","name":"Name","status":"Unpublished","availableFrom":"2025-10-16T03:03:36","availableFromTimeZone":"","availableUntil":"2025-10-17T03:03:36","availableUntilTimeZone":"","anonymityEnabled":true,"isTracking":false,"locales":[{"culture":"en-US","title":"Name"},{"culture":"da-DK","title":"Navn"}],"permissions":[{"departments":[],"userGroups":[],"requireAllUserGroups":false}],"creationDateTime":"2025-10-14T03:03:36.7964873+00:00","lastModifiedDateTime":null}]}
object
  count integer      
  ⯈ data array[object]      
   anonymityEnabled boolean      
   availableFrom string      
   availableFromTimeZone string      
   availableUntil string      
   availableUntilTimeZone string      
   creationDateTime datetimeoffset      
   id string / guid      
   isTracking boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   name string      
   ⯈ permissions array[object]      
    ⯈ departments array[object]      
     id string / guid      
     name string      
     url string      
    requireAllUserGroups boolean      
    ⯈ userGroups array[object]      
     id string / guid      
     name string      
     url string      
   status string      
  nextUrl string      
  previousUrl string