---
title: "Search form schemas"
method: POST
path: "/app/v1/form_schemas/search"
tags: ["form_schemas"]
---

# Search form schemas

`POST /app/v1/form_schemas/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'created_at' | 'name' — The sort key for form schema
  - `sort_direction` 'asc' | 'desc' — sort direction
  - `filter` object — A filter object for Form Schemas where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `id` string, uuid
    - `name` string
    - `status` 'active' | 'archived' | 'draft'
    - `version` string
    - `form_category.id` string
    - `form_category.name` string
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Response `200`

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)