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

Task Management

List
GET /taskmanagementmodules/{moduleId}/tasks 
https://api.relesystest.net/api/v1.3/taskmanagementmodules/{moduleId}/tasks
Get a list of tasks in a module with ID moduleId.

Default sort is by availableFrom in descending order.

The return object only includes the recurrence container itself as well as standalone tasks with no recurrence configured. They can be differentiated by checking the recurrence property, which is based on iCalendar RFC 5545 standard and defines how the system creates a list of tasks in a series.

assigneeIds is always null in this response due to the potential size of the returned data. The Get Task By ID endpoint returns the complete assignee information, and its documentation provides information on all assignee types.

Recurring tasks can be queried separately with Get Task Series By ID endpoint.

For more information on permissions and recurrence rules visit their respective concept pages.
Scopes: relesys.api, relesys.api:read, relesys.api.taskmanagement, relesys.api.taskmanagement:read
URL Path
moduleId string / guid The module's unique identifier required
Query String
assignedDepartmentType string Filterable Sortable optional
availableFrom datetime Filterable Sortable optional
availableFromTimeZone string Filterable optional
availableUntil datetime Filterable Sortable optional
availableUntilTimeZone string Filterable optional
creationDateTime datetimeoffset Filterable Sortable optional
disableComments boolean Filterable Sortable optional
hideAuthor boolean Filterable Sortable optional
id string / guid Filterable optional
isUnsynchronizedWithParent boolean Filterable Sortable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
lockByAvailableFrom boolean Filterable Sortable optional
lockByAvailableUntil boolean Filterable Sortable optional
name string Filterable Sortable optional
notifyManagerOfDepartmentType string Filterable Sortable optional
recurrence string Filterable optional
reminderDueSoonIntervalInDays integer Filterable Sortable optional
reminderIntervalInDays integer Filterable Sortable optional
serviceFormId 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
Schema Example
JSON
{"count":2,"data":[{"id":"ace10b14-afdc-480f-89bc-5d17bb8dc59e","name":"Internal name","recurrence":"","parentId":"9cb032e2-68d6-4697-a487-e4392b94e725","locales":[{"culture":"en-GB","title":"Title 1","summary":"Summary 1"}],"categoryIds":["566ef981-4310-48d2-b9ca-85f26831518f"],"availableFrom":"2025-10-10T13:00:00","availableFromTimeZone":"FLE Standard Time","availableUntil":"2025-10-10T14:00:00","availableUntilTimeZone":"FLE Standard Time","subtaskIds":null,"serviceFormId":"99c5af14-745d-46a4-9a0d-b73e280a4aa4","medias":null,"permissions":[{"departments":[{"url":null,"name":"Department 1","id":"ff434fb3-d36e-4ba6-8159-607a5d2c559b"},{"url":null,"name":"Department 2","id":"3ebbc68c-5beb-4a52-a650-e2c71c42fb8d"}],"userGroups":[{"url":null,"name":"User group 1","id":"4940ea7a-77bd-4048-b132-e22c92e7748b"},{"url":null,"name":"User group 2","id":"92b7e345-5985-4200-b11e-c1dca6827e25"}],"requireAllUserGroups":false}],"status":"Published","assigneeType":"Everyone","assigneeIds":null,"assignedDepartmentType":null,"notifyManagerOfDepartmentType":null,"reminderDueSoonIntervalInDays":null,"reminderIntervalInDays":null,"lockByAvailableFrom":false,"lockByAvailableUntil":false,"hideAuthor":false,"disableComments":false,"isUnsynchronizedWithParent":null,"creationDateTime":"2025-10-09T13:00:00+00:00","lastModifiedDateTime":null},{"id":"bf167fd9-e1e0-4cbf-a614-65ed11a803f1","name":"Internal name","recurrence":"FREQ=DAILY;DTSTART=20251010T130000;INTERVAL=1;COUNT=1","parentId":null,"locales":[{"culture":"en-GB","title":"Title 1","summary":"Summary 1"},{"culture":"en-GB","title":"Title 2","summary":"Summary 2"}],"categoryIds":["67d8a96b-419b-4ac2-9fba-53707f62b2c9","f4bd6c49-2e84-4d62-bc71-aa5a498eb2c7"],"availableFrom":"2025-10-10T13:00:00","availableFromTimeZone":"FLE Standard Time","availableUntil":"2025-10-10T14:00:00","availableUntilTimeZone":"FLE Standard Time","subtaskIds":["682689a4-b463-47ee-b2f0-7d98c8efca09","8e86c732-2e31-44f5-a9f9-e14a56070cf4"],"serviceFormId":null,"medias":[{"id":"60f8d929-2a98-4c62-bc90-f0e06aa4978e","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"FileName.png"},{"id":"eedf2e6a-574a-408d-9b72-12304d830de1","downloadUrl":null,"referenceUrl":null,"contentType":"image/png","fileName":"FileName.png"}],"permissions":[{"departments":[{"url":null,"name":"Department 1","id":"7339e657-526d-41dc-b5ef-d92b9e3693bf"},{"url":null,"name":"Department 2","id":"2262ad99-94fd-4cef-af98-87a31db6198c"}],"userGroups":[{"url":null,"name":"User group 1","id":"a7e97e0d-ac81-42b4-8bac-5b72ffdbfd12"},{"url":null,"name":"User group 2","id":"dcb0adfa-6304-499d-b948-a32020fbfa33"}],"requireAllUserGroups":false}],"status":"Published","assigneeType":"ByDepartmentType","assigneeIds":null,"assignedDepartmentType":"Region","notifyManagerOfDepartmentType":"Country","reminderDueSoonIntervalInDays":1,"reminderIntervalInDays":1,"lockByAvailableFrom":false,"lockByAvailableUntil":false,"hideAuthor":true,"disableComments":true,"isUnsynchronizedWithParent":null,"creationDateTime":"2025-10-09T13:00:00+00:00","lastModifiedDateTime":null}]}
object
  count integer      
  ⯈ data array[object]      
   assignedDepartmentType string      
   assigneeIds array[string / guid]      
   assigneeType string      
   availableFrom string      
   availableFromTimeZone string      
   availableUntil string      
   availableUntilTimeZone string      
   categoryIds array[string / guid]      
   creationDateTime datetimeoffset      
   disableComments boolean      
   hideAuthor boolean      
   id string / guid      
   isUnsynchronizedWithParent boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    summary string      
    title string      
   lockByAvailableFrom boolean      
   lockByAvailableUntil boolean      
   ⯈ medias array[object]      
    contentType string      
    downloadUrl string      
    fileName string      
    id string / guid      
    referenceUrl string      
   name string      
   notifyManagerOfDepartmentType string      
   parentId string / guid      
   ⯈ permissions array[object]      
    ⯈ departments array[object]      
     id string / guid      
     name string      
     url string      
    requireAllUserGroups boolean      
    ⯈ userGroups array[object]      
     id string / guid      
     name string      
     url string      
   recurrence string      
   reminderDueSoonIntervalInDays integer      
   reminderIntervalInDays integer      
   serviceFormId string / guid      
   status string      
   subtaskIds array[string / guid]      
  nextUrl string      
  previousUrl string