---
title: "Get Custom Field Usage Records"
method: GET
path: "/custom_fields/by-id/{custom_field_id}/usage"
tags: ["custom_fields"]
---

# Get Custom Field Usage Records

`GET /custom_fields/by-id/{custom_field_id}/usage`

## Request

- Base URL: `https://api.kobaltlabs.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.kobaltlabs.com/custom_fields/by-id/{custom_field_id}/usage`
- Auth: none declared

The records still holding a value for this field.

A field cannot be deleted while any record uses it, so the settings UI shows
this list to say exactly which records to clear.

## Path parameters

- `custom_field_id` string, uuid, required

## Query parameters

- `limit` integer

## Response `200`

Successful Response

- CustomFieldUsageResponse: The records blocking a custom field's deletion. `total` counts every record with a value; `records` is capped at the requested limit, so `len(records) < total` means the list was truncated.
  - `custom_field_id` string, uuid, required
  - `total` integer, required
  - `records` CustomFieldUsageRecord[]
    - `entity_id` string, uuid, required
    - `entity_type` 'VENDOR' | 'CANONICAL' | 'SERVICE' | 'ISSUE' | 'DISCLOSURE' | 'CONTRACT' | 'CONTACT', required
    - `label` string, required
    - `vendor_id` string, uuid, nullable
    - `vendor_entity_type` 'vendor' | 'partner' | 'merchant' | 'bank' | 'fintech_prospect' | 'loan_review' | 'self'

## Other responses

- `422`: Validation Error

---

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