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

Comments

Get Comments
GET /contentmodules/{moduleId}/content/{contentId}/comments 
https://api.relesysapp.net/api/v1.3/contentmodules/{moduleId}/content/{contentId}/comments
Get a list of content comments.
Default sort is by creationDateTime in descending order.

Please note: Comments must be enabled on the module for this endpoint to be called. Otherwise status code 400 - Bad Request will be returned.
Scopes: relesys.api, relesys.api:read, relesys.api.content, relesys.api.content:read
URL Path
moduleId string / guid required
contentId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
parentCommentId 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 400 401
Schema Example
JSON
{"count":2,"data":[{"id":"df91e42f-5586-4459-887d-62702b666abf","url":null,"userId":"65a99aea-8638-4bc2-bfdc-196f21797b88","userUrl":null,"parentCommentId":"9c68fec4-4833-44a9-9dec-8a13302cabf5","parentCommentUrl":null,"creationDateTime":"2025-01-22T05:10:45.0395838+00:00","lastModifiedDateTime":"2025-01-22T09:10:45.0395838+00:00","medias":[{"id":"63da1487-213a-47c0-b7b2-3fb534461899","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"png"},{"id":"74e96d6d-4eb9-44c7-9fc0-17f2c79b6532","downloadUrl":null,"referenceUrl":null,"contentType":"video/mp4","fileName":"mp4"}],"mentions":null,"locales":[{"culture":"en-GB","text":"Example text 1"}]},{"id":"f09afb62-a13d-4820-a12e-39ed0b0be652","url":null,"userId":"9104b6b9-00c7-4dcd-9c5b-fc929f2365d7","userUrl":null,"parentCommentId":"d7c81f38-0cb3-4298-8631-1259e9585346","parentCommentUrl":null,"creationDateTime":"2025-01-22T04:10:45.0395838+00:00","lastModifiedDateTime":null,"medias":null,"mentions":[{"type":"User","name":null,"id":"8986069c-65dc-44ae-821b-4809357ced5b","url":null},{"type":"Department","name":null,"id":"12bb5737-7665-4396-adcc-aada126368b2","url":null},{"type":"User group","name":null,"id":"429a9726-741e-448d-8a3d-120dcad5af8c","url":null}],"locales":[{"culture":"en-GB","text":"Example text 2"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    text string      
   ⯈ medias array[object]      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   ⯈ mentions array[object]      
    id string / guid      
    name string      
    type string      
    url string      
   parentCommentId string / guid      
   parentCommentUrl string      
   url string      
   userId string / guid      
   userUrl string      
  nextUrl string      
  previousUrl string