---
title: "GET /custom_fields"
method: GET
path: "/custom_fields"
tags: ["custom_fields"]
---

# GET /custom_fields

`GET /custom_fields`

Return list of custom fields

## Query parameters

- `with_total` boolean
- `entity` 'for_clients' | 'for_properties' | 'for_projects' | 'for_brokers' | 'for_tasks' | 'for_deals'
- `field_type` 'String' | 'Text' | 'Dropdown' | 'Multiselect' | 'Boolean' | 'Number' | 'Date' | 'DateTime' | 'CountrySelect' | 'CountrySelect' | 'Broker' | 'Tags' | 'TagsByCategory'

## Response `200`

Return list of custom fields

- EndpointsCustomFields — Endpoints_CustomFields model
  - `data` CustomFieldEntity[]
    - `id` integer
    - `custom_field_group_id` integer
    - `name` string
    - `pretty_name` string
    - `field_type` string
    - `entity` integer
    - `unit` string
    - `export_to_openimmo` boolean
    - `use_in_search_profile` boolean
    - `formula` string
    - `bequest` boolean
    - `custom_options` CustomOptionEntity[]
      - `id` integer
      - `name` string
  - `total` integer — Show the total count of CustomFields

## Other responses

- `400` — validation_error
- `401` — authentication_error
- `403` — authorization_error
- `404` — not_found_error
- `422` — validation_error
- `500` — internal_server_error

---

[API](https://skmtc.net/propstack/apis/propstack-api-v2-beta.md) · [All operations](https://skmtc.net/propstack/apis/propstack-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/propstack/propstack-api-v2-beta/revisions/ae1e0fe6da1a/schema)