Relesys API Docs

v1.1

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Events

Get Events
GET /calendarmodules/{moduleId}/calendars/{calendarId}/events 
https://api.relesysapp.net/api/v1.1/calendarmodules/{moduleId}/calendars/{calendarId}/events
Get a list of events.
Default sort is by startDate in descending order.

type - This field displays the type of the events. Currently, the available types are:
  • Event
  • ToDo
Scopes: relesys.api, relesys.api:read, relesys.api.calendars, relesys.api.calendars:read
URL Path
moduleId string / guid required
calendarId string / guid required
Query String
categoryId string / guid Filterable optional
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
isActive boolean Filterable optional
isCancelled boolean Filterable optional
isSignupEnabled boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
type string 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":"d4d7669b-119b-41d2-887d-8226727f262c","categoryId":null,"type":"ToDo","startDate":"2024-10-04T23:34:57.4260748Z","endDate":"2024-10-05T23:34:57.4260748Z","startDateTimeZone":"","endDateTimeZone":"","isActive":true,"isCancelled":false,"isSignupEnabled":false,"signupLimit":null,"numberOfSignups":null,"creationDateTime":"2024-10-03T23:34:57.4260748+00:00","lastModifiedDateTime":"2024-10-04T23:34:57.4260748+00:00","locales":[{"culture":"da-DK","title":"Event title example 1","summary":"Summary example 1"}],"individualInvitees":null},{"id":"eec06e9a-5f2d-4850-ac76-98d50c4b8c17","categoryId":"56939416-0c3c-42da-8f4b-9ac9c3cffa48","type":"Event","startDate":"2024-10-04T23:34:57.4260748Z","endDate":"2024-10-05T23:34:57.4260748Z","startDateTimeZone":"","endDateTimeZone":"","isActive":true,"isCancelled":false,"isSignupEnabled":true,"signupLimit":50,"numberOfSignups":0,"creationDateTime":"2024-10-03T23:34:57.4260748+00:00","lastModifiedDateTime":"2024-10-04T23:34:57.4260748+00:00","locales":[{"culture":"en-GB","title":"Event title example 2","summary":"Summary example 2"}],"individualInvitees":["2368e936-85e4-4837-b6ba-7daacd77a61f","43d35ab9-0bdc-44ea-a844-2f6afcba676d"]}]}
object
  count integer      
  ⯈ data array[object]      
   categoryId string / guid      
   creationDateTime datetimeoffset      
   endDate datetime      
   endDateTimeZone string      
   id string / guid      
   individualInvitees array[string / guid]      
   isActive boolean      
   isCancelled boolean      
   isSignupEnabled boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    summary string      
    title string      
   numberOfSignups integer      
   signupLimit integer      
   startDate datetime      
   startDateTimeZone string      
   type string      
  nextUrl string      
  previousUrl string