---
title: "List CustomField records"
method: GET
path: "/resource/CustomField"
tags: ["CustomField"]
---

# List CustomField records

`GET /resource/CustomField`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api/v1`
- URL: `https://your-subdomain.deputy.deputy.com/api/v1/resource/CustomField`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://once.deputy.com/my/oauth/login`
    - Token URL: `https://once.deputy.com/my/oauth/access_token`

Returns CustomField records the authenticated caller is permitted to see. For large tables prefer POST /QUERY with pagination.

## Response `200`

Success

- CustomField[]
  - `Id` integer, required
  - `System` string, required
  - `Name` string, required
  - `ApiName` string, required
  - `DeputyField` string, required
  - `SortOrder` integer
  - `Default` string
  - `Type` integer, required
  - `DisplayTiming` integer
  - `ConditionalRules` string
  - `Action` integer
  - `Published` integer
  - `Valuelist` string
  - `Visible` boolean
  - `EmployeeVisible` boolean
  - `TriggerScript` integer
  - `Validation` string
  - `Helptext` string
  - `Creator` integer
  - `Created` string, date-time
  - `Modified` string, required
  - `TriggerScriptObject` object

## Other responses

- `400`: Bad request
- `401`: Authentication required or invalid token
- `403`: Forbidden — token lacks access to this resource
- `404`: Resource not found

---

[API](https://skmtc.dev/deputy/apis/deputy-v1-resource-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v1-resource-api/revisions/5d8e44000786?raw)