---
title: "List Fields for the specified Form Template"
method: GET
path: "/v1/form-templates/{uuid}/fields"
tags: ["forms"]
---

# List Fields for the specified Form Template

`GET /v1/form-templates/{uuid}/fields`

Lists active Fields for a visible settings-level Form Template. This operation is available only to firm user credentials. Results default to deterministic creation order; `sort_by=sequence` uses Fieldguide display order.

## Path parameters

- `uuid` string, uuid, required

## Query parameters

- `types` FormFieldType[]
- `sort_by` 'created_at' | 'sequence'
- `page` number, nullable
- `per_page` number, nullable
- `sort_order` 'asc' | 'desc'

## Response `200`

The active Fields for the visible Form Template

- object
  - `data` FormFieldRead[], required
    - `uuid` string, uuid, required
    - `name` string, required
    - `type` 'short_text' | 'formatted_text' | 'date' | 'number' | 'image' | 'list', required — The value type accepted by this Field.
    - `sequence` integer, nullable, required — The Fieldguide display order. Null sequences appear first when sorting by sequence ascending and last when sorting descending.
    - `guidance` string, nullable, required — Safe canonical HTML for Field guidance. The supported reduced CKEditor markup is paragraphs, line breaks, bold (`strong`), italic (`em`), underline (`u`), strikethrough (`s`), and links (`a` with `href`).
    - `type_metadata` FormFieldTypeMetadata, required
      - `options` string[], required — Current allowed values for a list Field. Submit list values exactly as one of these options.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `_links` object, required
    - `self` object, required — The URL for the current page being fetched
      - `href` string
    - `first` object, required — The URL for the first page of the set
      - `href` string
    - `last` object, required — The URL for the last page of the set
      - `href` string
    - `previous` object — The URL for the previous page in the set, if there is one
      - `href` string
    - `next` object — The URL for the next page in the set, if there is one
      - `href` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden Forbidden (requires scopes `forms:read`) Forbidden for client user credentials; a firm user credential is required (requires scopes `forms:read`)
- `404` — Resource not found
- `429` — Too many requests

---

[API](https://skmtc.net/fieldguide/apis/fieldguide-api.md) · [All operations](https://skmtc.net/fieldguide/apis/fieldguide-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fieldguide/fieldguide-api/revisions/6f6009a58cdd/schema)
