Relesys API Docs

v1.3

https://api.uat.relesystest.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

Stage Comments

List
GET /serviceformModules/{moduleId}/forms/{formId}/stageComments 
https://api.uat.relesystest.net/api/v1.3/serviceformModules/{moduleId}/forms/{formId}/stageComments
Get a list of stage comments for the form with ID formId.

Please note: This endpoint is only available if stages are enabled on the service form module.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
moduleId string / guid required
formId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
fillingId string / guid Filterable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
stageId string / guid Filterable optional
userId 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":"50d74c74-8651-4f54-b9c1-9ce3734cf12c","url":null,"fillingId":"11c97382-8998-4cc6-b23e-b371e5e65a06","fillingUrl":null,"stageId":"2edab6bf-1799-4beb-a912-c9ee827a822a","stageUrl":null,"userId":"2157dacc-d828-4f01-ad0e-dcd2370f2d9a","userUrl":null,"creationDateTime":"2026-01-12T14:58:53.8470337+00:00","lastModifiedDateTime":"2026-01-13T14:58:53.8470337+00:00","value":"Stage Comment 1","medias":[{"id":"d73e284e-9740-49ab-8d7b-897a70e26610","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"87891fe6-2a6d-458e-a741-8d2dce1ec9b2","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"5bb22743-9e00-476b-818e-98078a28e983","url":null,"fillingId":"e988e093-39cf-40ca-ad12-63a3f75913d8","fillingUrl":null,"stageId":"af48ede6-f52b-4624-8edc-ee920f75dcd1","stageUrl":null,"userId":"3485739d-c25e-4985-ab7d-0669b8e2b3f2","userUrl":null,"creationDateTime":"2026-01-12T14:58:53.8470337+00:00","lastModifiedDateTime":null,"value":"Stage Comment 2","medias":[]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   fillingId string / guid      
   fillingUrl string      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ medias array[object]      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   stageId string / guid      
   stageUrl string      
   url string      
   userId string / guid      
   userUrl string      
   value string      
  nextUrl string      
  previousUrl string