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

Pages

List
GET /serviceformModules/{moduleId}/forms/{formId}/pages 
https://api.relesysapp.net/api/v1.3/serviceformModules/{moduleId}/forms/{formId}/pages
Get a list of pages for the form with ID formId
Default sort is by sortOrder in ascending order.
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
stageId 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":"e4958c3e-1d9b-423d-bb0f-0a645b642514","url":null,"stageId":"d7b9e4a1-3960-440c-adce-5ecf73625464","stageUrl":null,"sortOrder":1,"name":"Service form page example 1","isVisible":true,"creationDateTime":"2024-07-26T08:31:51.3587836+00:00","lastModifiedDateTime":"2024-07-27T08:31:51.3587836+00:00"},{"id":"18013259-5442-48dd-8153-aee4ac8ce75a","url":null,"stageId":null,"stageUrl":null,"sortOrder":2,"name":"Service form page example 2","isVisible":true,"creationDateTime":"2024-07-26T08:31:51.3587836+00:00","lastModifiedDateTime":null}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   id string / guid      
   isVisible boolean      
   lastModifiedDateTime datetimeoffset      
   name string      
   sortOrder integer      
   stageId string / guid      
   stageUrl string      
   url string      
  nextUrl string      
  previousUrl string