---
title: "Retrieve all custom properties"
method: GET
path: "/api/v2/organizations/{orgSlug}/custom-properties"
tags: ["Custom Properties"]
---

# Retrieve all custom properties

`GET /api/v2/organizations/{orgSlug}/custom-properties`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/custom-properties`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.settings.customProperties.read`

Retrieve all custom properties. 

 Required scopes: `flex.settings.customProperties.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` CustomPropertyResultDto[]
    - `_id` string: The _id of the custom property.
    - `key` string: The name of the custom property. This is the unique identifier which you use when applying the property.
    - `title` string: The title of the custom property.
    - `placeholder` string: The placeholder of the custom property.
    - `type` string: The type of the custom property.
    - `privacy` string: The privacy setting of the custom property.
    - `targets` string[]: The system entities for which the custom property can be applied.
    - `values` string[]: An array containg the possible values for custom properties of type "Select" and "Multi-Select".
    - `rates` string[]: An array containg the rates for which the property applies. This relates only to custom properties that apply for bookings.

---

[API](https://skmtc.dev/officernd/apis/settings-api.md) - [All operations](https://skmtc.dev/officernd/apis/settings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/settings-api/revisions/656d8878f9e2?raw)