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

# Search form submissions

`POST /app/v1/form_submissions/search`

## Query parameters

- `answers` string

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'created_at' | 'status' | 'answer'
  - `sort_direction` 'asc' | 'desc' — sort direction
  - `filter` object — A filter object for Form Submissions 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
    - `version` integer
    - `current_version` boolean
    - `status` 'validated' | 'invalidated' | 'pending' | 'submitted' | 'draft'
    - `form_category_id` string
    - `form_category.name` string
    - `form_schema.id` string
    - `form_schema.name` string
    - `form_schema.version` number
    - `form_schema.current_version` boolean
    - `form_schema.status` 'active' | 'archived' | 'draft'
    - `related_entity_id` string, uuid
    - `created_by` string, uuid
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `event.id` string, uuid
    - `measurement.measurement_type` string
    - `measurement.measurement_unit` string
    - `measurement.source_id` string, uuid
    - `measurement.subject_id` string, uuid
    - `measurement.form_submission_id` string, uuid
    - `measurement.section_id` string
    - `measurement.question_id` string
    - `measurement.question_index` number
    - `measurement.time` string, date-time

## Response `200`

successful operation

- PagedFormSubmissionList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` union[]
    - union
      - FormSubmissionWithoutAnswers
        - `company_id` string, uuid
        - `created_by` string, uuid
        - `form_schema_id` string, uuid
        - `form_schema_version` number
        - `id` string, uuid
        - `status` 'validated' | 'invalidated' | 'pending' | 'submitted' | 'draft'
      - FormSubmissionWithAnswers
        - `company_id` string, uuid
        - `created_by` string, uuid
        - `form_schema_id` string, uuid
        - `form_schema_version` number
        - `id` string, uuid
        - `status` 'validated' | 'invalidated' | 'pending' | 'submitted' | 'draft'
        - `answers` object
        - `form_schema` FormSchema
          - `company_id` string, uuid
          - `config` FormSchemaConfig
            - `questions` object
            - `sections` object[]
              - …
          - `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

---

[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)