GUguesty
Custom Fields

Get Custom Field from Selected Property

Retrieve a specific custom field for a select property using the custom field ID.

get/properties-api/custom-fields/{propertyId}/{fieldId}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/properties-api/custom-fields/{propertyId}/{fieldId}
  • Auth
    API key in header authorization

Path parameters

propertyIdstring required

The Guesty property ID.

fieldIdstring required

The custom field ID.

Response

Returns the custom fields set on the specified property.

propertyIdstring
fieldIdstring
valuestring
fullTextstring

If the value is a long text, the response will return a truncated version, and the complete text will be stored successfully.

displayNamestring
keystring
typestring
optionsstring[]
objectstring

Custom field type

isPublicboolean

Example response

{
  "propertyId": "5aa90b5a23f67f001f4115b6",
  "fieldId": "5bf14ff5163f2e0037331fe1",
  "displayName": "Some Field",
  "key": "test",
  "type": "text",
  "options": [
    "value 1",
    "value 2"
  ],
  "isPublic": true,
  "value": "value 1"
}

Changes

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