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":"74ce6b1a-a979-4fd8-b396-6749f5c67ff6","url":null,"fillingId":"dc319964-dc8d-4cec-b26a-095b21c1f2da","fillingUrl":null,"stageId":"d0852b7b-d90f-40e0-ad0a-8230f71e38a0","stageUrl":null,"userId":"367a8d9b-2271-4c17-9e11-f47679158bd3","userUrl":null,"creationDateTime":"2025-01-21T04:51:34.9385102+00:00","lastModifiedDateTime":"2025-01-22T04:51:34.9385102+00:00","value":"Stage Comment 1","medias":[{"id":"543b5696-ba35-414b-b111-7d7fbeb95d46","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"3a869ef3-b9dc-4ec7-8720-87ed3c02cdbe","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"272671e3-683a-466a-8da8-8e87c31515f6","url":null,"fillingId":"871b33f7-3642-4602-8185-c3bbad83226a","fillingUrl":null,"stageId":"df0fcf35-5dd7-49ce-b7ff-9b9b47ab88d1","stageUrl":null,"userId":"f28af9b8-2977-498a-b9ed-b32451dee86c","userUrl":null,"creationDateTime":"2025-01-21T04:51:34.9385102+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