API - Planyo Web Services - list_custom_user_properties

You are here: Planyo » Help » API » list_custom_user_properties

list_custom_user_properties

Description:

Returns a listing of custom user property definitions for a site.

Input:

site_id int optional

If using a metasite API key, you must specify the site ID for which the custom user properties should be returned. Otherwise leave this empty.

method string required

must be set to list_custom_user_properties

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

custom_user_properties array

Array of custom user property definitions. Each item is an array with the following keys: name (name with underscores instead of spaces and other non-alphanumeric characters), type (1=dropdown list, 2=text item, 3=yes/no checkbox), dropdown_values (comma-separated, used only for dropdown lists), default_value, form_item_name (name of the reservation form item associated with this custom user property)

API playground:

Click here to test this function in the API playground.