---
title: "getCustomFields"
method: GET
path: "/getCustomFields"
tags: ["CustomFields"]
---

# getCustomFields

`GET /getCustomFields`

Gets custom fields list<br /> ¹ data.displayed = "booking" - Display this field to guests on the booking engine.<br /> ¹ data.displayed = "reservation" - Add this field to the reservation folio for use by staff.<br /> ¹ data.displayed = "card" - Make this field available for registration cards.<br />

## Query parameters

- `propertyID` string
- `customFieldID` string
- `shortcode` string

## Response `200`

200 Response

- GetCustomFieldsResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Field details
    - `propertyID` string — Unique hotel identifier
    - `name` string — Field name
    - `shortcode` string — Internal reference and is used for integration purposes such as custom links and the API
    - `applyTo` 'reservation' | 'guest' — Where put this field in reservation or guest section of the booking.
    - `required` boolean — Specify whether this field is required to be filled out.
    - `isPersonal` boolean — Specifies if the contents of this field may contain personal information (GDPR).
    - `maxCharacters` integer — Maximum number of characters allowed to be entered in this field.
    - `type` 'input' | 'text' — The field's input type.
    - `displayed` string[] — ¹ Specify where this custom field to show up.
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

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