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

# List custom fields

`GET /v2/custom-fields`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/custom-fields`
- Auth: API key in header `x-api-key`

List the custom fields you've set up to store extra details on customers and policies. Results come back one page at a time.

## Query parameters

- `page` number
- `perPage` number
- `recordType` 'customers' | 'policies': Filter by record type
- `sortBy` 'createdAt' | 'fieldLabel' | 'fieldType': Field to sort by
- `sortDirection` 'asc' | 'desc': Sort direction

## Response `200`

GET /v2/custom-fields Positive response

- GetV2CustomFieldsPositiveResponse
  - `itemsTotal` number, required
  - `currentPage` number, required
  - `nextPage` number, nullable, required
  - `prevPage` number, nullable, required
  - `items` object[], required: List of custom field definitions
    - `id` string, uuid, required
    - `createdAt` string, date-time, nullable, required: Custom field definition creation time. ISO 8601 timestamp
    - `updatedAt` string, date-time, nullable, required: Custom field definition last update time. ISO 8601 timestamp
    - `clientId` string, uuid, required
    - `recordType` 'customers' | 'policies', required
    - `fieldKey` string, required: Generated identifier for the field
    - `fieldLabel` string, required: Display name shown to users
    - `fieldDescription` string, required: Description of the field's purpose
    - `fieldType` 'text' | 'number' | 'boolean' | 'date' | 'select' | 'multi_select', required: Type of data this field stores
    - `isRequired` boolean, nullable, required: Whether this field must have a value
    - `options` string[], nullable, required: Available options for select/multi-select fields
    - `validationRules` union, required: Validation rules for the custom field
      - string
      - number
      - boolean
      - object
      - unknown[]
        - unknown
    - `deleted` boolean, required
    - `deletedAt` string, date-time, nullable, required: Custom field definition deletion time. ISO 8601 timestamp

## Other responses

- `400`: GET /v2/custom-fields Negative response 400
- `401`: GET /v2/custom-fields Negative response 401
- `403`: GET /v2/custom-fields Negative response 403
- `404`: GET /v2/custom-fields Negative response 404
- `409`: GET /v2/custom-fields Negative response 409
- `422`: GET /v2/custom-fields Negative response 422
- `429`: GET /v2/custom-fields Negative response 429
- `500`: GET /v2/custom-fields Negative response 500
- `502`: GET /v2/custom-fields Negative response 502
- `503`: GET /v2/custom-fields Negative response 503

---

[API](https://skmtc.dev/carecycle/apis/carecycle-public-api.md) - [All operations](https://skmtc.dev/carecycle/apis/carecycle-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carecycle/apis/carecycle-public-api/revisions/db390c743c36?raw)