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

NotificationChannels

Get Channels
GET /communication/notifications/channels 
https://api.relesysapp.net/api/v1.3/communication/notifications/channels
Get a list of notification channels.
Default sort is by name in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.notifications, relesys.api.notifications:read
Query String
id string / guid Filterable optional
name string Filterable Sortable optional
pushEnabled boolean 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":"f62c4e4c-ffbc-45f8-a99b-19f4caafe770","name":"Notification Channel 1","description":"Notification Channel 1 description","pushEnabled":true,"locales":[{"culture":"en-GB","channelName":null,"defaultTitle":"Title","defaultMessage":"Body text"},{"culture":"da-DK","channelName":null,"defaultTitle":"Title","defaultMessage":"Body text"}]},{"id":"832d6da9-d16e-472b-b558-d9d482fb69c6","name":"Notification Channel 2","description":"Notification Channel 2 description","pushEnabled":false,"locales":[{"culture":"en-GB","channelName":null,"defaultTitle":"Title","defaultMessage":"Body text"},{"culture":"da-DK","channelName":null,"defaultTitle":"Title","defaultMessage":"Body text"}]}]}
object
  count integer      
  ⯈ data array[object]      
   description string      
   id string / guid      
   ⯈ locales array[object]      
    channelName string      
    culture string      
    defaultMessage string      
    defaultTitle string      
   name string      
   pushEnabled boolean      
  nextUrl string      
  previousUrl string