Relesys API Docs

v1.1

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

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

Fields

Get Fields
GET /serviceforms/{serviceFormId}/forms/{formId}/pages/{pageId}/fields 
https://api.relesysapp.net/api/v1.1/serviceforms/{serviceFormId}/forms/{formId}/pages/{pageId}/fields
Get all fields related to a page with ID pageId.
Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read
URL Path
serviceFormId string / guid required
formId string / guid required
pageId string / guid required
Query String
creationDateTime datetimeoffset Filterable Sortable optional
dataListId string / guid Filterable optional
externalId string Filterable optional
fieldGroupId string / guid Filterable optional
formId string / guid Filterable optional
id string / guid Filterable optional
isRequired boolean Filterable optional
isVisible boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
name string Filterable Sortable optional
pageId string / guid Filterable optional
scoreCategoryId string / guid Filterable optional
type string Filterable Sortable optional
sortOrder integer 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":"079068cb-bb19-4d52-abda-c87354586440","formId":"ab2676e2-fd66-4a30-bc30-fd6cd595cedf","pageId":"6fd1c563-666a-42e7-882b-e8e3b04ad17a","dataListId":"0220db2c-ec9c-4064-a7ff-146f9e146dc1","scoreCategoryId":"68179018-d85a-412a-92c0-72ccc3f13c5e","fieldGroupId":"f844dbc3-bed9-4ae8-a4f1-bf12951f55e1","externalId":"Field 1","creationDateTime":"2026-01-30T06:30:14.398146+00:00","lastModifiedDateTime":null,"type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"9e3f3f1c-715f-4769-9eac-79763a59ad0b","formId":"c0521df0-a606-42a8-8aaf-f665fb2812d3","pageId":"286bea0e-6b97-426f-918f-121ebbcceeba","dataListId":null,"scoreCategoryId":null,"fieldGroupId":null,"externalId":"Field 2","creationDateTime":null,"lastModifiedDateTime":null,"type":"Text","name":"Service form field example 2","sortOrder":1,"isRequired":true,"isVisible":true}]}
object
  count integer      
  ⯈ data array[object]      
   creationDateTime datetimeoffset      
   dataListId string / guid      
   externalId string      
   fieldGroupId string / guid      
   formId string / guid      
   id string / guid      
   isRequired boolean      
   isVisible boolean      
   lastModifiedDateTime datetimeoffset      
   name string      
   pageId string / guid      
   scoreCategoryId string / guid      
   sortOrder integer      
   type string      
  nextUrl string      
  previousUrl string