> ## Documentation Index
> Fetch the complete documentation index at: https://docs.guardhousehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List form templates

> Returns the form templates available to your API key. Useful for populating the `id` parameter on `/api/external/incidentreport/formtemplate`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/external/incidentreport/formtemplate/list
openapi: 3.1.0
info:
  title: Guardhouse API
  version: 1.0.0
  description: >-
    The Guardhouse API gives external systems programmatic access to incident
    reports, timesheets, staff, customers, sites, and webhook event
    subscriptions.


    All endpoints return a consistent envelope (`ApiResponse`,
    `ApiPagedResponse`, or `ApiPostPagedResponse`). Authentication is a two-step
    flow: exchange a long-lived **API key** for a short-lived **JWT bearer
    token**, then send the bearer on every subsequent request.
  contact:
    name: Guardhouse Support
  license:
    name: Proprietary
servers:
  - url: https://gateway-api.guardhousehq.com
    description: AU production
  - url: https://gateway-api.guardhousehq.co.uk
    description: UK production
security:
  - bearerAuth: []
    subscriptionKey: []
tags:
  - name: Authentication
    description: >-
      Exchange a long-lived API key for a short-lived JWT bearer token. The
      token must be sent as `Authorization: Bearer <token>` on every subsequent
      request.
  - name: Incident Reports
    description: >-
      List, fetch, and export incident reports submitted against your customers
      and sites. Requires an API key with `KeyType=incidentreport`.
  - name: Timesheets
    description: List timesheet entries and fetch per-entry rate breakdowns.
  - name: Live Operations
    description: >-
      Retrieve live shift and employee operational data, including clock-in
      status, location, welfare checks, and license details.
  - name: Staff
    description: >-
      List, create, and update employees and their security licenses. Read
      endpoints (`GET /api/external/staffs`, `GET
      /api/external/staffs/{id}/licenses`) are accessible with any valid Public
      API key. Write endpoints (`POST`, `PATCH`, `GET /staffs/search`) require
      `KeyType=developer`.
  - name: Customers
    description: List customer records visible to your API key.
  - name: Sites
    description: List sites visible to your API key.
  - name: Webhooks
    description: >-
      Manage webhook subscribers and event subscriptions so Guardhouse can
      notify your systems when incident reports or timesheets change. Requires
      an API key with `KeyType=developer`.
  - name: Login Audit
    description: >-
      Read-only access to login activity (successful logins, failed logins, and
      reserved logout events) for your company. **Requires an API key issued
      with the `login-audits.read` entitlement scope** — keys without this
      special scope are rejected at the auth layer with `403 Forbidden`. Tokens
      minted from such a key carry `login-audits.read` in their `Scope` claim,
      which is what the endpoint checks.
paths:
  /api/external/incidentreport/formtemplate/list:
    get:
      tags:
        - Incident Reports
      summary: List form templates
      description: >-
        Returns the form templates available to your API key. Useful for
        populating the `id` parameter on
        `/api/external/incidentreport/formtemplate`.
      parameters:
        - name: formName
          in: query
          schema:
            type: string
        - $ref: '#/components/parameters/ReferenceIdParam'
        - $ref: '#/components/parameters/ReferenceNameParam'
        - name: showActiveOnly
          in: query
          description: When `true` (default), exclude archived templates.
          schema:
            type: boolean
            default: true
        - name: limit
          in: query
          description: Maximum number of templates to return.
          schema:
            type: integer
            format: int32
            default: 200
        - $ref: '#/components/parameters/DirectionParam'
      responses:
        '200':
          description: List of form templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormTemplateListEnvelope'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    ReferenceIdParam:
      name: referenceId
      in: query
      description: >-
        Cursor anchor ID. Pass the last `incidentReportId` (or equivalent) you
        saw to fetch the next page.
      schema:
        type: integer
        format: int32
    ReferenceNameParam:
      name: referenceName
      in: query
      description: Cursor anchor name when paginating across results sorted by name.
      schema:
        type: string
    DirectionParam:
      name: direction
      in: query
      description: >-
        Cursor pagination direction. Use `next` to page forward and `prev` to
        page back.
      schema:
        type: string
        enum:
          - next
          - prev
        default: next
  schemas:
    FormTemplateListEnvelope:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/FormTemplate'
    ApiResponse:
      type: object
      description: The standard envelope for every JSON endpoint.
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          description: Endpoint-specific payload. `null` when an error occurred.
          nullable: true
        count:
          type: integer
          format: int32
          nullable: true
        message:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    FormTemplate:
      type: object
      properties:
        id:
          type: integer
          format: int32
        formName:
          type: string
    Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: Numeric service result code. `0` indicates success.
        errorMessage:
          type: string
          description: Human-readable error message; empty on success.
    Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 100
        message:
          type: string
  responses:
    Forbidden:
      description: >-
        The bearer token is missing the required policy or `KeyType` claim, or
        the resource is outside your API key's scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT issued by `POST /api/external/token/request`. Send as
        `Authorization: Bearer <token>`.
    subscriptionKey:
      type: apiKey
      in: header
      name: external-gh-apim-sub-key
      description: >-
        Guardhouse API Management subscription key. Required on every request.
        The same value is used by all API consumers within a region — contact
        Guardhouse Support for the subscription key.

````