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

Endpoints

Stage Comments

List
GET /serviceformModules/{moduleId}/forms/{formId}/stageComments 
https://api.relesysapp.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":"ff96bcb5-08dd-4107-a782-395423ea1742","url":null,"fillingId":"328e40d5-987c-4d4e-8561-452df2dc0fa6","fillingUrl":null,"stageId":"99ef6451-465a-44a3-b5b1-5336567981bd","stageUrl":null,"userId":"74ad25cf-f5eb-4c86-9ee4-51867babed9f","userUrl":null,"creationDateTime":"2025-03-20T13:44:13.3161467+00:00","lastModifiedDateTime":"2025-03-21T13:44:13.3161467+00:00","value":"Stage Comment 1","medias":[{"id":"d1e94f72-f39a-4620-9ae3-e751db55b02b","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"c80a4371-facf-483d-b778-649a49560c69","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"1cc500c5-db15-4bf4-9a6f-70bd37cccb7f","url":null,"fillingId":"1a47d9e5-8d9b-42eb-a3a8-db72a22c66b2","fillingUrl":null,"stageId":"f1401f29-f1be-4d3f-acce-37cc863a0109","stageUrl":null,"userId":"3ec5c7c2-8533-4024-85b7-593399479505","userUrl":null,"creationDateTime":"2025-03-20T13:44:13.3161467+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