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

Pages

List
GET /serviceformModules/{moduleId}/forms/{formId}/pages 
https://api.relesysapp.net/api/v1.2/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":"28cdc65f-7d15-4dfd-b64e-4dfa65b556bf","url":null,"stageId":"e5509f60-3f2b-4bf9-b4e0-6862d656202c","stageUrl":null,"sortOrder":1,"name":"Service form page example 1","isVisible":true,"creationDateTime":"2024-04-27T07:09:14.6851974+00:00","lastModifiedDateTime":"2024-04-28T07:09:14.6851974+00:00"},{"id":"1cb2753b-b595-4226-b7bb-b6ce40d726ae","url":null,"stageId":null,"stageUrl":null,"sortOrder":2,"name":"Service form page example 2","isVisible":true,"creationDateTime":"2024-04-27T07:09:14.6851974+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