CLcloudbeds
CustomFields

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 />

get/getCustomFields

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getCustomFields
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:customFields

Query parameters

propertyIDstring

Property ID

customFieldIDstring

Field identifier

shortcodestring

Internal reference and is used for integration purposes such as custom links and the API

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.