Relesys API Docs

v1.2

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Stages

List
GET /serviceformModules/{moduleId}/forms/{formId}/stages 
https://api.relesysapp.net/api/v1.2/serviceformModules/{moduleId}/forms/{formId}/stages
Get a list of stages for the form with ID formId.
Default sort is by sortOrder in ascending order.

Please note: This endpoint is only available if stages are enabled on the service form module.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
moduleId string / guid required
formId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
id string / guid Filterable optional
isVisible boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name 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":"01ee0a95-dc6c-46f8-bcee-57add62dd340","url":null,"creationDateTime":"2024-04-22T22:51:13.5902075+00:00","lastModifiedDateTime":"2024-04-27T22:51:13.5902075+00:00","name":"Service form stage example 1","sortOrder":1,"isVisible":true,"locale":[{"culture":"da-DK","title":"Title example 1","description":"Description example 1"},{"culture":"en-GB","title":"Title example 2","description":"Description example 2"}]},{"id":"4496855d-bc43-4e60-8674-92623b46b1bc","url":null,"creationDateTime":"2024-03-26T22:51:13.5902075+00:00","lastModifiedDateTime":null,"name":"Service form stage example 2","sortOrder":2,"isVisible":true,"locale":[{"culture":"da-DK","title":"Title example 3","description":"Description example 3"}]}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   isVisible boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locale array[object]      
    culture string      
    description string      
    title string      
   name string      
   sortOrder integer      
   url string      
  nextUrl string      
  previousUrl string