---
title: "Retrieve custom fields data"
method: GET
path: "/management/v2/custom-fields"
tags: ["Custom Fields"]
---

# Retrieve custom fields data

`GET /management/v2/custom-fields`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/management/v2/custom-fields`
- Auth: API key in header `OAuth`

Retrieve custom fields data.

## Query parameters

- `recordType` 'ROSTER' | 'TIMESHEET' | 'EMPLOYEE'
- `areas` integer[]

## Response `200`

A successful response.

- CustomFieldsGetResponse
  - `success` boolean
  - `data` TenantcustomFieldsv2modelCustomField[]
    - `id` integer
    - `recordType` 'ROSTER' | 'TIMESHEET' | 'EMPLOYEE'
    - `title` string
    - `identifier` string
    - `dataField` string
    - `sortOrder` integer
    - `defaultValue` string
    - `type` integer
    - `displayTiming` integer
    - `conditionalRules` string
    - `action` integer
    - `published` boolean
    - `valueList` string[]
    - `visible` boolean
    - `triggerScript` integer
    - `validation` string[]
    - `helptext` string
    - `areas` integer[]
    - `creator` integer
    - `createdAt` string
    - `modifiedAt` string
    - `employeeVisible` boolean

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)