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

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":"aba039d1-feac-4a0e-bf39-8e4ed40dde68","formId":"3bceb8dd-7b47-4e99-b817-09b77a8975c8","pageId":"47d1863f-fb7d-427f-b62f-e1ffda958cf6","dataListId":"dd06415a-2b04-4c9a-9829-e0f7b63e86e3","scoreCategoryId":"8f0b44d5-961f-40c5-8f1b-71d3f7764dc0","fieldGroupId":"4bb23655-0802-4f28-b949-6c4890e3dd7f","externalId":"Field 1","creationDateTime":"2025-06-12T15:56:39.5905237+00:00","lastModifiedDateTime":null,"type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"064a64a7-82eb-4ad0-81da-48f95aba69cf","formId":"cc977ae7-797e-4424-9f72-c06ca20fbb86","pageId":"5b096c8d-f6c3-403a-b762-b2c352c12c32","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