---
title: "List Custom Fields"
method: GET
path: "/ca/api/v1/custom-fields"
tags: ["Company Objects"]
---

# List Custom Fields

`GET /ca/api/v1/custom-fields`

List all custom fields for a given app and model.

        Supports including soft-deleted records for audit and recovery purposes.
        When include_deleted=true, returns ONLY deleted records instead of active records.
        Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
        and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
        This provides clean separation between active and deleted data.

## Query parameters

- `app` string
- `include_deleted` boolean
- `is_active` boolean
- `last_modified_at__gte` string
- `last_modified_at__lte` string
- `limit` integer
- `model` string
- `offset` integer

## Response `200`

- PaginatedCustomFieldList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` CustomField[], required
    - `id` integer, required
    - `app` string, required
    - `model` string, required
    - `name` string, required
    - `label` string, required
    - `field_type` 'text' | 'single_select' | 'date' | 'number' | 'boolean', required — * `text` - Free Text * `single_select` - Single Select * `date` - Date * `number` - Number * `boolean` - Boolean
    - `options` unknown
    - `is_required` boolean
    - `display_order` integer
    - `is_active` boolean
    - `include_on_invoice` boolean
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `last_modified_at` string, date-time, required
    - `is_deleted` boolean, required
    - `deleted_at` string, date-time, nullable, required

---

[API](https://skmtc.net/campfire/apis/campfire-developer-apis.md) · [All operations](https://skmtc.net/campfire/apis/campfire-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/campfire/campfire-developer-apis/versions/6945ebc3180e/schema)