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

# List forms by type

> Returns forms for a specific type. Allowed values: consent, survey, level_of_support, custom_fields, presence_status, tasks.



## OpenAPI

````yaml /src/autogen/incoming-openapi3.0.yaml get /v1/forms/type/{type}
openapi: 3.1.0
info:
  description: >-
    This OpenAPI 3.1 specification describes the public API of the Qomon
    platform. It is generated from the code and serves both as documentation for
    API consumers and as a contract for future development.
  title: Qomon API Reference
  version: 0.0.1
servers:
  - description: Production
    url: https://incoming.qomon.app
security:
  - bearerAuth: []
tags:
  - description: >-
      Create, read, update, and delete Qomon contacts.


      **Basic fields:** name, email, phone, address, tags, gender, birthdate,
      etc.


      **Advanced fields:** consents, surveys, custom fields, level of support,
      tasks.


      **Operations:**

      - `/contacts/upsert` (async) — Recommended for synchronizing and
      mass-updating contacts

      - `/contacts` (sync) — Create individual contacts

      - `/contacts/{id}` (sync) — Read, update, or delete individual contacts
    name: Contacts
  - description: >-
      Retrieve form definitions and their possible values (refvalues).


      **Use forms to:**

      - Understand and interpret contact advanced fields

      - Look up valid values for consents, surveys, custom fields, task
      assignments

      - Explore available form types and their structure


      **Form types:** consent, level_of_support, presence_status, custom_fields,
      survey, tasks
    name: Forms
paths:
  /v1/forms/type/{type}:
    get:
      tags:
        - Forms
      summary: List forms by type
      description: >-
        Returns forms for a specific type. Allowed values: consent, survey,
        level_of_support, custom_fields, presence_status, tasks.
      operationId: list-forms-by-type
      parameters:
        - description: Form type.
          in: path
          name: type
          required: true
          schema:
            description: Form type.
            enum:
              - consent
              - survey
              - level_of_support
              - custom_fields
              - presence_status
              - tasks
            examples:
              - consent
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusEnvelopeFormsDataWrapper'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
components:
  schemas:
    StatusEnvelopeFormsDataWrapper:
      additionalProperties: true
      properties:
        data:
          $ref: '#/components/schemas/FormsDataWrapper'
        status:
          description: Operation result.
          examples:
            - success
          type: string
      required:
        - status
        - data
      type: object
    ErrorModel:
      additionalProperties: true
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    FormsDataWrapper:
      additionalProperties: true
      properties:
        forms:
          items:
            $ref: '#/components/schemas/Form'
          type:
            - array
            - 'null'
      required:
        - forms
      type: object
    ErrorDetail:
      additionalProperties: true
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Form:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the form was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the form was last updated.
          format: date-time
          readOnly: true
          type: string
        group_id:
          description: IDs of groups the form belongs to.
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        id:
          format: int64
          minimum: 0
          type: integer
        label:
          description: Label of the form.
          examples:
            - Volunteer registration
          type: string
        refvalues:
          description: >-
            A list of possible answers or predefined values associated with the
            form. These can be simple options or a range of values, depending on
            the form type.
          items:
            $ref: '#/components/schemas/Refvalue'
          type:
            - array
            - 'null'
        type:
          description: The format of the form.
          enum:
            - text
            - radio
            - numeric
            - checkbox
            - date
            - range
            - signature
            - photos
          examples:
            - radio
          type: string
      required:
        - id
        - label
        - type
        - refvalues
      type: object
    Refvalue:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the refvalue was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the refvalue was last updated.
          format: date-time
          readOnly: true
          type: string
        form_id:
          description: ID of the form to which this refvalue belongs.
          format: int64
          minimum: 0
          type: integer
        id:
          description: Unique identifier of the refvalue.
          format: int64
          minimum: 0
          type: integer
        label:
          description: Label of the refvalue.
          examples:
            - 'Yes'
          type: string
        max:
          description: Maximum value for numeric or range forms.
          examples:
            - 5
          format: int64
          minimum: 0
          type: integer
        min:
          description: Minimum value for numeric or range forms.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        order:
          description: The order in which the refvalues should be displayed for selection.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        step:
          description: >-
            Step value for numeric or range forms, indicating the increments
            between valid values.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        value:
          description: >-
            The actual value associated with the refvalue. This is what gets
            stored when the form is submitted.
          examples:
            - 'yes'
          type: string
      required:
        - id
        - form_id
        - label
        - value
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: opaque
      description: >-
        OAuth2 access token. Pass the token in the Authorization header as
        `Bearer <token>`. The token is looked up in Redis to resolve the caller
        identity.
      scheme: bearer
      type: http

````