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":"19aa1692-275b-4cc3-b3b6-9260452a6dfa","url":null,"fillingId":"ffb6e0a2-5b04-4ae7-b2af-0e615d34c88a","fillingUrl":null,"stageId":"97e542c2-5c13-439d-aeed-5be8a8cfbfcb","stageUrl":null,"userId":"264993bc-d505-4df0-98b2-68ed36fe935d","userUrl":null,"creationDateTime":"2025-03-03T11:15:56.7188324+00:00","lastModifiedDateTime":"2025-03-04T11:15:56.7188324+00:00","value":"Stage Comment 1","medias":[{"id":"54a43076-8f7e-48c1-94e2-d6c075719f06","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"70d1c9d1-13e4-45d0-93cd-f63daa38effb","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"fa015230-5f22-4ab3-8896-62881cb7fd4f","url":null,"fillingId":"5e075dd8-1ba3-43eb-a0f1-223e49e2fe61","fillingUrl":null,"stageId":"89941dae-4deb-4948-9640-cb2e0ef7075d","stageUrl":null,"userId":"a0ab47e6-d8e5-4fe9-af3f-40ebffd56933","userUrl":null,"creationDateTime":"2025-03-03T11:15:56.7188324+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