---
title: "List profile custom-field definitions"
method: GET
path: "/settings/profile-fields/{entity}"
tags: ["Settings"]
---

# List profile custom-field definitions

`GET /settings/profile-fields/{entity}`

## Request

- Base URL: `https://api.cavuno.com/v1`
- URL: `https://api.cavuno.com/v1/settings/profile-fields/{entity}`
- Auth: HTTP bearer

Lists candidate or company profile field definitions in display order. Includes private definitions. Requires `settings.read`.

## Path parameters

- `entity` 'candidate' | 'company', required

## Response `200`

Definition list.

- ProfileCustomFieldDefinition[]
  - `key` string, required
  - `label` string, required
  - `helpText` string
  - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone' | 'image_gallery' | 'file', required
  - `required` boolean, required
  - `visibility` 'private' | 'public', required
  - `editableByOwner` boolean, required
  - `options` object[]
    - `key` string, required
    - `label` string, required
  - `min` number
  - `max` number

## Other responses

- `default`: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.

## Changes

- **2026-10-19** `c34152c38176`: 1 info
  - added the optional property `error/upgrade` to the response with the `default` status

[Operation history](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/changes/settings/profile-fields/:entity/get.md)

---

[API](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api.md) · [All operations](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/revisions/d5974dabff14?raw)