---
title: "List AI custom field definitions"
method: GET
path: "/accounts/self/ai/custom-fields"
tags: ["Fax AI"]
---

# List AI custom field definitions

`GET /accounts/self/ai/custom-fields`

Get all custom field definitions for AI field extraction. (Permitted scopes: **fax:all:read**, **fax:ai_settings:read**)

## Response `200`

Response containing a list of custom field definitions

- AiCustomFieldList — List of AI custom field definitions
  - `records` AiCustomField[] — List of custom field definitions
    - `id` string, required — Unique identifier for the custom field
    - `name` string, required — Display name of the custom field
    - `instructions` string, required — AI extraction instructions for this field
    - `enabled` boolean, required — Whether this custom field is active

## Other responses

- `401` — Error object in case there's a problem with the authorization
- `500` — Error object in case there's a server error

---

[API](https://skmtc.net/fax/apis/fax-plus-rest-api.md) · [All operations](https://skmtc.net/fax/apis/fax-plus-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fax/fax-plus-rest-api/revisions/c1afc85d2c15/schema)