---
title: "Get all Custom Fields"
method: GET
path: "/custom_field"
tags: ["custom-fields"]
---

# Get all Custom Fields

`GET /custom_field`

This method allows to retrieve and filter custom fields.

## Query parameters

- `entity` 'case' | 'run' | 'defect'
- `type` 'string' | 'text' | 'number' | 'checkbox' | 'selectbox' | 'radio' | 'multiselect' | 'url' | 'user' | 'datetime'
- `limit` integer
- `offset` integer

## Response `200`

Custom Field list.

- CustomFieldsResponse
  - `status` boolean
  - `result` object
    - `total` integer
    - `filtered` integer
    - `count` integer
    - `entities` CustomField[]
      - `id` integer
      - `title` string
      - `entity` string
      - `type` string
      - `placeholder` string, nullable
      - `default_value` string, nullable
      - `value` string, nullable
      - `is_required` boolean
      - `is_visible` boolean
      - `is_filterable` boolean
      - `is_enabled_for_all_projects` boolean
      - `created` string — Deprecated, use the `created_at` property instead.
      - `updated` string, nullable — Deprecated, use the `updated_at` property instead.
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `projects_codes` string[]

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `429` — Too Many Requests.

---

[API](https://skmtc.dev/qase/apis/qase-io-testops-api-v1.md) · [All operations](https://skmtc.dev/qase/apis/qase-io-testops-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qase/qase-io-testops-api-v1/revisions/12ddc644fac5/schema)
