---
title: "Get a custom property detail for a given entity type"
method: GET
path: "/v1/custom-properties/{target_entity}/{key}"
tags: ["Custom properties"]
---

# Get a custom property detail for a given entity type

`GET /v1/custom-properties/{target_entity}/{key}`

Returns a list of all custom properties in your dotfile workspace for a given entity type

## Path parameters

- `target_entity` 'case' | 'company' | 'individual', required
- `key` string, required

## Response `200`

Detailed custom property

**ℹ️ Click to see full payload**

- union
  - CustomPropertyBoolean
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'boolean', required
  - CustomPropertyChoicesWithOptions
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'choices', required
    - `settings` CustomPropertyChoicesSettings, required
      - `allow_multiple` boolean, required
    - `options` CustomPropertyOption[], required
      - `label` string, required
      - `key` string, required
  - CustomPropertyCountries
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'countries', required
    - `settings` CustomPropertyCountriesSettings, required
      - `allow_multiple` boolean, required
  - CustomPropertyDate
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'date', required
  - CustomPropertyEmail
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'email', required
  - CustomPropertyNumeric
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'numeric', required
    - `settings` CustomPropertyNumericSettings, required
      - `format` 'number' | 'percent' | 'currency', required
      - `min` number, float, nullable, required
      - `max` number, float, nullable, required
      - `currency_code` string, nullable, required — Only when format=currency. Currency code in format ISO 4217. see https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes
  - CustomPropertyPhoneNumber
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'phone_number', required
  - CustomPropertyText
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'text', required
    - `settings` CustomPropertyTextSettings, required
      - `is_multi_line` boolean, required
  - CustomPropertyUrl
    - `id` string, uuid, required
    - `label` string, required
    - `key` string, required
    - `target_entity` 'case' | 'company' | 'individual', required
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `updated_at` string, date-time, required — Latest update date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `archived_at` string, date-time, nullable, required — Archival date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `type` 'url', required

## Other responses

- `404` — No custom property can be found.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)