---
title: "Get custom fields"
method: GET
path: "/api/v2/custom_fields"
tags: ["Custom Fields"]
---

# Get custom fields

`GET /api/v2/custom_fields`

List custom fields with optional filters and pagination.

## Query parameters

- `filter` union — Filter schema for `custom_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.
  - FilterCustomField — Filter parameters for listing custom fields. Supports filtering by customizable type (task, deal, person, etc.), project, section, name, archived status, and data type. Standard string and ID operators apply.
    - `project_id` union — Filter by the associated project.
      - ProjectId — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `eq` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `not_eq` ProjectId — unresolved $ref
        - `not_contain` ProjectId — unresolved $ref
    - `show_in_add_edit_views` union — Filter by whether the custom field is shown in add/edit views.
      - ShowInAddEditViews — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` ShowInAddEditViews — unresolved $ref
        - `eq` ShowInAddEditViews — unresolved $ref
        - `not_contain` ShowInAddEditViews — unresolved $ref
        - `not_eq` ShowInAddEditViews — unresolved $ref
    - `name` union — Filter by custom field name (text search).
      - Name — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `not_contain` Name — unresolved $ref
        - `contains` Name — unresolved $ref
        - `not_eq` Name — unresolved $ref
        - `eq` Name — unresolved $ref
    - `archived` union — Filter by whether the custom field is archived.
      - object — Filter using explicit operator syntax.
        - `not_contain` Archived — unresolved $ref
        - `contains` Archived — unresolved $ref
        - `not_eq` Archived — unresolved $ref
        - `eq` Archived — unresolved $ref
      - Archived — unresolved $ref
    - `global` union — Filter by whether the custom field is global (applies to all records of its type).
      - Global — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `contains` Global — unresolved $ref
        - `not_contain` Global — unresolved $ref
        - `not_eq` Global — unresolved $ref
        - `eq` Global — unresolved $ref
    - `survey_id` union — Filter by the associated survey.
      - SurveyId — unresolved $ref
      - object — Filter using explicit operator syntax.
        - `not_contain` SurveyId — unresolved $ref
        - `not_eq` SurveyId — unresolved $ref
        - `contains` SurveyId — unresolved $ref
        - `eq` SurveyId — unresolved $ref
    - `customizable_type` union — Filter by the resource type the custom field is attached to.
      - object — Filter using explicit operator syntax.
        - `contains` CustomizableType — unresolved $ref
        - `not_eq` CustomizableType — unresolved $ref
        - `not_contain` CustomizableType — unresolved $ref
        - `eq` CustomizableType — unresolved $ref
      - CustomizableType — unresolved $ref
- `sort` string[]

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection custom 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/11e8576224b8/schema)