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

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
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":"48128ed2-a217-4720-a6f9-d462981900c6","formId":"e62749e4-8465-407c-b774-40192f6fedee","pageId":"7268244a-efab-423d-bd57-11ab18fdd632","dataListId":"8eea3efb-9415-49e7-8462-fe8daf2fbaa2","scoreCategoryId":"838b66b7-216e-4aee-899b-5429dd2d4b73","fieldGroupId":"ec877d69-1fd2-4766-bc30-eb507b80affa","externalId":"Field 1","creationDateTime":"2025-10-26T19:03:27.5423152+00:00","lastModifiedDateTime":null,"type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"636bb245-fd90-457d-babc-652e5873a627","formId":"9e4e88e1-878f-45a0-936a-95c29b38e6d8","pageId":"2ff977ba-061b-40bc-a757-0764af8d1d09","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