---
title: "Get survey fields"
method: GET
path: "/api/v2/survey_fields"
tags: ["Survey Fields"]
---

# Get survey fields

`GET /api/v2/survey_fields`

List all survey fields.

## Query parameters

- `sort` string[]
- `filter` union — Filter schema for `survey_field` list endpoints — pass a single condition or a logical group.
  - object — A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required — Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.
  - FilterSurveyField — Filter parameters for listing survey fields. Supports filtering by survey. Standard ID operators apply.
    - `archived` union — Filter to include only archived (or non-archived) survey fields.
      - object — Filter using explicit operator syntax.
        - `not_contain` Archived — unresolved $ref
        - `contains` Archived — unresolved $ref
        - `eq` Archived — unresolved $ref
        - `not_eq` Archived — unresolved $ref
      - Archived — unresolved $ref
    - `name` union — Filter by field name (text search).
      - object — Filter using explicit operator syntax.
        - `not_contain` Name — unresolved $ref
        - `not_eq` Name — unresolved $ref
        - `eq` Name — unresolved $ref
        - `contains` Name — unresolved $ref
      - Name — unresolved $ref
    - `show_in_add_edit_views` union — Filter by whether the field is shown in add/edit form views.
      - object — Filter using explicit operator syntax.
        - `contains` ShowInAddEditViews — unresolved $ref
        - `eq` ShowInAddEditViews — unresolved $ref
        - `not_contain` ShowInAddEditViews — unresolved $ref
        - `not_eq` ShowInAddEditViews — unresolved $ref
      - ShowInAddEditViews — unresolved $ref
    - `origin_field_id` union — Filter by the original field this field was copied from.
      - object — Filter using explicit operator syntax.
        - `not_contain` OriginFieldId — unresolved $ref
        - `eq` OriginFieldId — unresolved $ref
        - `not_eq` OriginFieldId — unresolved $ref
        - `contains` OriginFieldId — unresolved $ref
      - OriginFieldId — unresolved $ref
    - `survey_id` union — Filter by the associated survey.
      - SurveyId — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` SurveyId — unresolved $ref
        - `eq` SurveyId — unresolved $ref
        - `not_eq` SurveyId — unresolved $ref
        - `not_contain` SurveyId — unresolved $ref
    - `global` union — Filter by whether the survey field applies globally across all projects.
      - Global — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `eq` Global — unresolved $ref
        - `not_eq` Global — unresolved $ref
        - `not_contain` Global — unresolved $ref
        - `contains` Global — unresolved $ref
    - `project_id` union — Filter by the associated project.
      - object — Filter using explicit operator syntax.
        - `not_contain` ProjectId — unresolved $ref
        - `not_eq` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `eq` ProjectId — unresolved $ref
      - ProjectId — unresolved $ref

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection survey field

---

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