GUguesty
Accounts

Get a custom field configuration

Changed on

Retrieve a single custom field definition by its ID. The field_id is the fieldId value returned when listing or creating custom fields.

get/accounts/{id}/custom-fields/{field_id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/accounts/{id}/custom-fields/{field_id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Guesty account ID or me

field_idstring required

Custom field id

Response

Custom Field

displayNamestring

The internal variable name of the custom field. Read-only: it is derived by the server from key (trimmed, whitespace replaced with underscores, lowercased), so a value sent by the client is ignored.

isPublicboolean

Indicates whether the custom field is visible to all users or only those with custom field permissions.

isRequiredboolean

Whether a value must be supplied for this field. Applies to reservation custom fields only — it is ignored for listing custom fields, which the Guesty UI always creates with isRequired: false.

keystring

The plain text display name of the custom field

object'listing' | 'reservation'

Whether the custom field is for listings or reservations

optionsstring[]

Your custom list of options, for the enum field type. For type: user the system populates the options internally with the account's users, but this property is still returned as an empty array — an empty array here does not mean the account has no users.

type'boolean' | 'contact' | 'date' | 'dayofweek' | 'enum' | 'longtext' | 'number' | 'text' | 'time' | 'user'

The data type of the custom field. Indicates the type of content that can be input into the field. The "Team member" option in the Guesty UI creates a field of type user — there is no separate team_member type, and both produce the same result.

fieldIdstring

The unique identifier of the custom field

Example response

{
  "fieldId": "5dc03b42e28baf001e2b35d0"
}

Changes

  • 3122b8618183Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id accountsCustomFieldGet was added

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status