---
title: "List custom properties per entity type"
method: GET
path: "/v1/custom-properties/{target_entity}"
tags: ["Custom properties"]
---

# List custom properties per entity type

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

Returns a paginated list of custom properties for a given entity type. Options are not included in this list; use the detail endpoint to retrieve options.

## Path parameters

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

## Query parameters

- `label` string
- `key` string
- `include_archived` boolean
- `created_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `updated_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `sort` string
- `page` number
- `limit` number

## Response `200`

List of custom properties for entity type

**ℹ️ Click to see full payload**

- CustomPropertyList
  - `data` union[], required
    - 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
      - CustomPropertyChoices
        - `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
      - 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
  - `pagination` Pagination, required
    - `page` number, required — Current page number (defined in query parameter)
    - `limit` number, required — Item count per page (defined in query parameter)
    - `count` number, required — Total items count

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter. - If specified, make sure the value of the `page` or `limit` query parameter are valid. - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.

---

[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)