---
title: "Get a custom_field"
method: GET
path: "/v1/custom_fields/{id}"
tags: ["Custom Fields"]
---

# Get a custom_field

`GET /v1/custom_fields/{id}`

Retrieve a custom field by ID

## Path parameters

- `id` string, required

## Response `200`

successful

- CustomField
  - `id` string, required — The custom field ID
  - `field_key` string, required — The unique field key
  - `display_name` string, required — The human-readable field name
  - `entity_type` 'Household' | 'Person' | 'Contact' | 'Opportunity', required — The entity type this field applies to
  - `field_type` 'text' | 'number' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'cross_reference', required — The field data type
  - `options` object, nullable — Field-specific options (e.g., select_options for select fields, cross_reference_allowed_target_types for cross_reference)
    - `select_options` string[]
    - `cross_reference_allowed_target_types` string[]

## Other responses

- `400` — bad request - invalid JSON
- `401` — unauthorized - missing or invalid token
- `403` — forbidden
- `404` — not found

---

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