Skip to main content
GET
/
api
/
external
/
incidentreport
/
formtemplate
/
list
List form templates
curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/incidentreport/formtemplate/list \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": [
    {
      "id": 123,
      "formName": "<string>"
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT issued by POST /api/token/request. Send as Authorization: Bearer <token>.

Query Parameters

formName
string
referenceId
integer<int32>

Cursor anchor ID. Pass the last incidentReportId (or equivalent) you saw to fetch the next page.

referenceName
string

Cursor anchor name when paginating across results sorted by name.

showActiveOnly
boolean
default:true

When true (default), exclude archived templates.

limit
integer<int32>
default:200

Maximum number of templates to return.

direction
enum<string>
default:next

Cursor pagination direction. Use next to page forward and prev to page back.

Available options:
next,
prev

Response

List of form templates

The standard envelope for every JSON endpoint.

status
object
data
object[]

Endpoint-specific payload. null when an error occurred.

count
integer<int32> | null
message
string
errors
object[]