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":"3effff62-4954-44ce-bcb4-8dd0953e24db","url":null,"fillingId":"ad0516e7-4971-4fd0-9ca7-06c1622f4563","fillingUrl":null,"stageId":"b44d5ff7-fbfd-4ec0-adca-f394a792601a","stageUrl":null,"userId":"b10123bd-04eb-4f21-8b65-3f34e202d247","userUrl":null,"creationDateTime":"2025-04-02T21:46:04.3641223+00:00","lastModifiedDateTime":"2025-04-03T21:46:04.3641223+00:00","value":"Stage Comment 1","medias":[{"id":"15fdcdec-ba48-4765-ace3-99b8ee268c80","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"561b1535-f95a-4cef-94db-1fdea554f2db","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"}]},{"id":"a3527f78-0ad8-4ed0-bd69-15f8246544a6","url":null,"fillingId":"12992976-0328-405a-bafb-bfd43715eaa5","fillingUrl":null,"stageId":"41a94732-2fdb-4e12-b4bc-bb4bf84781aa","stageUrl":null,"userId":"b662f6df-763a-484f-bbdc-aa01d3aa1fc1","userUrl":null,"creationDateTime":"2025-04-02T21:46:04.3641223+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