Relesys API Docs

Stages

Get Stages

GET /serviceforms/{serviceFormId}/forms/{formId}/stages

https://api.relesysapp.net/api/v1.1/serviceforms/{serviceFormId}/forms/{formId}/stages

Get all stages for the specified form with ID formId.

Please note: This endpoint is only available if stages are enabled on the service form module.

Scopes: relesys.api, relesys.api:read, relesys.api.serviceform, relesys.api.serviceform:read

URL Path

serviceFormId	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
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

Schema Example

JSON

{"count":2,"data":[{"id":"b58c4a68-ac55-4b06-a327-0f8306de2d80","formId":"b5a87734-f7ce-4479-980a-3b00c31fa874","creationDateTime":"2024-09-29T23:49:57.7242559+00:00","lastModifiedDateTime":"2024-10-04T23:49:57.7242559+00:00","name":"Service form stage example 1","sortOrder":1,"isVisible":true},{"id":"8607bcb3-62ff-47e8-a961-37a42d56f599","formId":"7de42da5-e1d4-4e66-96b6-23b7f18a1255","creationDateTime":"2024-09-02T23:49:57.7242559+00:00","lastModifiedDateTime":null,"name":"Service form stage example 2","sortOrder":2,"isVisible":true}]}

object
count	integer
⯈ data	array[object]
creationDateTime	datetimeoffset
formId	string / guid
id	string / guid
isVisible	boolean
lastModifiedDateTime	datetimeoffset
name	string
sortOrder	integer
nextUrl	string
previousUrl	string

Relesys API Docs

v1.1

Welcome

Concepts

Endpoints

Stages

URL Path

Query String

Responses