Relesys API Docs

v1.3

https://api.relesystest.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings Recurrence Rules

Endpoints

Content

List
GET /contentmodules 
https://api.relesystest.net/api/v1.3/contentmodules
Get a list of content modules and their settings

Default sort is by name in ascending order.

Permission Settings:
Content modules support flexible permission configurations that determine who can access and interact with content:
  • permissionSettingType - Defines how access is granted:
    • Departments - Access is granted based on specified departments
    • UserGroups - Access is granted based on specified user groups
    • DepartmentsAndUserGroups - Access is granted based on both specified departments AND user groups
    • DepartmentsOrUserGroups - Access is granted based on either specified departments OR user groups
  • permissionSettingDepartmentTypes - The list of departments that can be used for granting access, will be restricted to these types of departments

Notification Settings:
  • notificationsEnabled - Enables or disables all notifications for the module
  • pushNotificationsEnabled - Enables or disables the possiblity of sending push notifications
  • forceInstantPushEnabled - If enabled, it is possible to send push notifications instantly

Scopes: relesys.api, relesys.api:read, relesys.api.content, relesys.api.content:read
Query String
creationDateTime datetime Filterable Sortable optional
forceInstantPushEnabled boolean Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetime Filterable Sortable optional
name string Filterable Sortable optional
notificationsEnabled boolean Filterable Sortable optional
permissionSettingType string Filterable Sortable optional
pushNotificationsEnabled boolean Filterable Sortable 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":"d869e9c1-8c67-4f48-b8b0-d389c3a5614b","name":"Example name 1","permissionSettingType":"Both departments and user groups","permissionSettingDepartmentTypes":["Company","Country","Department"],"notificationsEnabled":true,"pushNotificationsEnabled":true,"forceInstantPushEnabled":true,"creationDateTime":"2026-01-14T15:03:06.0480837Z","lastModifiedDateTime":"2026-01-15T15:03:06.0480837Z"},{"id":"b0665961-d84d-4d71-944d-6e12d178b52e","name":"Example name 2","permissionSettingType":null,"permissionSettingDepartmentTypes":null,"notificationsEnabled":true,"pushNotificationsEnabled":false,"forceInstantPushEnabled":false,"creationDateTime":"2026-01-14T15:03:06.0480837Z","lastModifiedDateTime":null}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetime      
   forceInstantPushEnabled boolean      
   id string / guid      
   lastModifiedDateTime datetime      
   name string      
   notificationsEnabled boolean      
   permissionSettingDepartmentTypes array[string]      
   permissionSettingType string      
   pushNotificationsEnabled boolean      
  nextUrl string      
  previousUrl string