---
title: "Get Custom Property"
method: GET
path: "/properties/{property_id}"
tags: ["custom properties"]
---

# Get Custom Property

`GET /properties/{property_id}`

This endpoint retrieves a single custom property by its `property_id` or `property_name`, along with its options for dropdown and picklist kinds

If the same property name exists under both chat and ticket, pass the `type` query parameter to specify which one to fetch

_If `type` is omitted and the name matches both, `data` is returned as an array containing every match_

## Path parameters

- `property_id` string, required

## Query parameters

- `type` 'chat' | 'ticket'

## Response `200`

200 OK. `data` is a single property object, or an array of property objects when the name matches both a chat and a ticket property and no `type` was given

- object
  - `success` boolean
  - `data` union
    - object
      - `property_id` string — The unique identifier of the property
      - `property_name` string — The name of the property
      - `type` 'chat' | 'ticket' — The type the property belongs to
      - `kind` string — The value kind of the property - text, date, file, dropdown or picklist
      - `mandatory` boolean — Whether the property is mandatory. Applicable to ticket properties only
      - `section_id` string, nullable — The id of the section the property belongs to, or null if it is not in a section
      - `section_name` string, nullable — The name of the section the property belongs to, or null if it is not in a section
      - `options` object[] — The current option list. Present only for dropdown and picklist kinds
        - `id` string
        - `label` string
      - `created_at` string — When the property was created
    - object[]
      - `property_id` string — The unique identifier of the property
      - `property_name` string — The name of the property
      - `type` 'chat' | 'ticket' — The type the property belongs to
      - `kind` string — The value kind of the property - text, date, file, dropdown or picklist
      - `mandatory` boolean — Whether the property is mandatory. Applicable to ticket properties only
      - `section_id` string, nullable — The id of the section the property belongs to, or null if it is not in a section
      - `section_name` string, nullable — The name of the section the property belongs to, or null if it is not in a section
      - `options` object[] — The current option list. Present only for dropdown and picklist kinds
        - `id` string
        - `label` string
      - `created_at` string — When the property was created

## Other responses

- `404` — No matching property
- `422` — Invalid type

---

[API](https://skmtc.net/periskope/apis/api-local.md) · [All operations](https://skmtc.net/periskope/apis/api-local/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/periskope/api-local/versions/f2738ced87d8/schema)