Relesys API Docs

v1.2

https://api.relesysapp.net/api/v1.2

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Content

Get Content
GET /contentmodules/{moduleId}/content 
https://api.relesysapp.net/api/v1.2/contentmodules/{moduleId}/content
Get a list of content.

startDateTimeZone and endDateTimeZone determine the timezone for which the content post's availability is based upon. If they are not set, the timezone is based upon the timezone for the user accessing the post.
locales, mentions and medias will always be null in this response due to the potential of very large body texts. In order to include these, please use the Get Content By Id (url) endpoint.

Default sort is by sortOrder in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.content, relesys.api.content:read
URL Path
moduleId string / guid required
Query String
availableFrom datetime Filterable Sortable optional
availableUntil datetime Filterable Sortable optional
categoryId string / guid Filterable optional
creationDateTime datetimeoffset Filterable Sortable optional
featureMediaId string / guid Filterable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name string Filterable Sortable optional
sortOrder integer Filterable Sortable optional
status string Filterable Sortable 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 401
Schema Example
JSON
{"count":2,"data":[{"id":"b0a18470-4696-4ab2-8e8d-7fa052140614","url":null,"userId":"1f5a6327-4645-4314-8226-a09ca46f7132","userUrl":null,"categoryId":"b2d972dd-bc3c-404b-af19-b27e92d8c7c7","categoryUrl":null,"sortOrder":1,"status":"Published","creationDateTime":"2024-04-25T23:56:39.6619492+00:00","lastModifiedDateTime":null,"availableFrom":"2024-04-26T23:56:39Z","startDateTimeZone":null,"availableUntil":"2024-04-27T23:56:39Z","endDateTimeZone":null,"medias":null,"featureMediaId":null,"featureMediaDownloadUrl":null,"mentions":null,"locales":null},{"id":"6965f35e-649d-4922-a317-4612b7e5b20b","url":null,"userId":"79a95a05-0a75-48e9-a5ea-489547444e07","userUrl":null,"categoryId":"6219534d-3997-41ed-ad0e-84eb2f05137e","categoryUrl":null,"sortOrder":2,"status":"Draft","creationDateTime":"2024-04-25T23:56:39.6619492+00:00","lastModifiedDateTime":"2024-04-26T19:56:39.6619492+00:00","availableFrom":"2024-04-26T23:56:39Z","startDateTimeZone":null,"availableUntil":"2024-04-27T23:56:39Z","endDateTimeZone":null,"medias":null,"featureMediaId":"2a5234ab-99ab-45b9-85fe-853843bacedb","featureMediaDownloadUrl":null,"mentions":null,"locales":null}]}
object
  count integer      
  ⯈ data array[object]      
   availableFrom datetime      
   availableUntil datetime      
   categoryId string / guid      
   categoryUrl string      
   creationDateTime datetimeoffset      
   endDateTimeZone string      
   featureMediaDownloadUrl string      
   featureMediaId string / guid      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    bodyText string      
    culture string      
    title 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      
   sortOrder integer      
   startDateTimeZone string      
   status string      
   url string      
   userId string / guid      
   userUrl string      
  nextUrl string      
  previousUrl string