Vacatia API Catalog
/
Cloudbeds API
/
CustomFields
/
getCustomFields

Cloudbeds API (v1.2)

Welcome to the documentation for Cloudbeds API Version v1.2! If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data for your Cloudbeds customers, then you've come to the right place.

In this document you will find all the API methods we provide along with explanations for parameters and response examples.

If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our Integrations Portal.

Be sure to subscribe to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.

Endpoint: https://api.cloudbeds.com/api/v1.2/{method}

HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.

Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)

Response Format: JSON

Response Header: X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.

Run in Postman use this link to access our Public collection in Postman.

Download OpenAPI description
cloudbeds.json
cloudbeds.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/cloudbeds/
https://api.cloudbeds.com/api/v1.2/

Authentication

Operations

Adjustment

Operations

AllotmentBlocks

Operations

AppSettings

Operations

Currency

Operations

CustomFields

Operations

getCustomFields

Request

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

Query
propertyIDstring

Property ID

customFieldIDstring

Field identifier

shortcodestring

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

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getCustomFields?customFieldID=string&propertyID=string&shortcode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataArray of objects

Field details

messagestring or null

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

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "message": "string"
}

postCustomField

Request

Sets custom fields. The call should only be made once to add the field to the system.

Bodyapplication/x-www-form-urlencoded
propertyIDstring or null

Property ID

namestring

Field name

shortcodestring

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

applyTostring or null

Where put this field in reservation or guest section of the booking. reservation - applies the custom field to reservations in myfrontdesk guest - applies the custom field to guest interface in myfrontdesk

Default "reservation"
Enum"reservation""guest"
requiredboolean or null

Specify whether this field is required to be filled out.

Default false
maxCharactersinteger or null

Maximum number of characters allowed to be entered in this field.

Default 40
typestring or null

The field's input type.

Default "input"
Enum"input""text"
displayedArray of strings or null

¹ Specify where this custom field to show up. reservation - applies the custom field to reservation interface in myfrontdesk booking - applies the custom field to the booking engine card - applies the custom field to Registration cards

isPersonalboolean

Specifies if the contents of this field may contain personal information. User's personal information may be removed upon request according to GDPR rules.

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postCustomField \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d propertyID=string \
  -d name=string \
  -d shortcode=string \
  -d applyTo=reservation \
  -d required=false \
  -d maxCharacters=40 \
  -d type=input \
  -d displayed=reservation \
  -d isPersonal=true

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject

Field details

messagestring or null

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

Response
application/json
{
  "success": true,
  "data": {
    "fieldID": "string",
    "name": "string",
    "shortcode": "string"
  },
  "message": "string"
}

Dashboard

Operations

Emails

Operations

Groups

Operations

Guest

Operations

Hotel

Operations

HouseAccount

Operations

Housekeeping

Operations

Integration

Operations

Invoices

Operations

Item

Operations

Package

Operations

Payment

Operations

Rate

Operations

Reservation

Operations

Room

Operations

Taxes and Fees

Operations

User

Operations