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":"db7d97bf-b213-4244-92bb-82ac69778e5b","formId":"db883ed2-65bc-4822-b55c-47aecc8f44b0","pageId":"3a652a88-ef1f-44e4-ad94-0c1ef4f0ffc7","dataListId":"5163cd56-91ec-4bc3-abf5-c4e7ebca9d32","scoreCategoryId":"65c3ddd1-a27a-429d-a4a3-a9c41cb618e6","fieldGroupId":"e6e5e3f0-bcdc-49a6-b748-4cd3160a3f85","externalId":"Field 1","creationDateTime":"2025-07-03T02:38:57.037413+00:00","lastModifiedDateTime":null,"type":"DataList","name":"Service form field example 1","sortOrder":1,"isRequired":true,"isVisible":true},{"id":"5f0cab2a-672a-441f-ad0c-67e5729c62b8","formId":"c241f1b9-4d06-4ec3-95e1-1c85e4920b64","pageId":"949286f0-b0ea-4245-96dc-4c55c0ba3ff7","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