---
title: "CustomProperty"
method: GET
path: "/custom-properties/{publicId}"
tags: ["CustomProperty"]
---

# CustomProperty

`GET /custom-properties/{publicId}`

## Path parameters

- `publicId` string, required

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `publicId` string
    - `scopeType` 'glb' | 'app' | 'sct' | 'usr' | 'com'
    - `resourceType` string
    - `resourceVariant` string, nullable
    - `slug` string
    - `name` string
    - `description` string, nullable
    - `required` boolean
    - `validation` union
      - object
        - `type` 'bool', required
      - object
        - `type` 'datetime', required
      - object
        - `type` 'emailaddress', required
      - object
        - `type` 'enum', required
        - `options` string[]
      - object
        - `type` 'int', required
        - `minValue` integer, nullable
        - `maxValue` integer, nullable
      - object
        - `type` 'locale', required
      - object
        - `type` 'str', required
        - `minLength` integer, nullable
        - `maxLength` integer, nullable
        - `regex` string, nullable
      - object
        - `type` 'timezone', required
      - object
        - `type` 'url', required
    - `flags` string[]

## Other responses

- `4XX` — 4XX error response

---

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