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

Categories

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

Default sort is by sortOrder in ascending order.

Please note: Categories must be enabled on the module for this endpoint to be called. Otherwise status code 400 - Bad Request will be returned.
Scopes: relesys.api, relesys.api:read, relesys.api.content, relesys.api.content:read
URL Path
moduleId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name string Filterable Sortable optional
sortOrder integer 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 400 401
Schema Example
JSON
{"count":2,"data":[{"id":"86892483-ac62-40bc-9163-ee62daa2d6ee","name":"Example name 1","sortOrder":1,"creationDateTime":"2024-11-20T06:58:04.5987588+00:00","lastModifiedDateTime":null,"locales":[{"culture":"en-GB","title":"Example title 1"}]},{"id":"02c10b5c-eff5-4f62-a36b-7af660dd4b1c","name":"Example name 2","sortOrder":2,"creationDateTime":"2024-11-20T06:58:04.5987588+00:00","lastModifiedDateTime":"2024-11-21T02:58:04.5987588+00:00","locales":[{"culture":"en-GB","title":"Example title 2"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    title string      
   name string      
   sortOrder integer      
  nextUrl string      
  previousUrl string