---
title: "List form schema"
method: GET
path: "/app/v1/form_schemas"
tags: ["form_schemas"]
---

# List form schema

`GET /app/v1/form_schemas`

## Query parameters

- `name` string
- `status` 'archived' | 'active' | 'draft'
- `form_category_id` string, uuid
- `form_category_name` string
- `page_size` number
- `page` number
- `sort_by` string
- `sort_direction` 'asc' | 'desc'

## Response `200`

A successful operation

- PagedFormSchemaList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` FormSchemaWithCategory[]
    - `company_id` string, uuid
    - `config` FormSchemaConfig
      - `questions` object
      - `sections` object[]
        - `description` string, required
        - `id` string, required
        - `name` string, required — Should not start with a number
        - `is_repeatable` boolean
        - `questions` string[], required
    - `created_at` string, date-time
    - `created_by` string, uuid
    - `description` string
    - `form_submission_editable` boolean
    - `form_category_id` string, uuid
    - `id` string, uuid
    - `name` string
    - `status` 'active' | 'archived' | 'draft'
    - `updated_at` string, date-time
    - `version` integer
    - `form_category` FormCategory
      - `archived` boolean
      - `company_id` string, uuid
      - `created_at` string, date-time
      - `id` string, uuid
      - `name` string
      - `updated_at` string, date-time

---

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