API - Planyo Web Services - get_custom_property

You are here: Planyo » Help » API » get_custom_property

get_custom_property

Description:

Returns value of a property. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations. Please note that custom properties will be visible in the backend UI (for site administrators) unless the property name starts with 'hidden'. In such case the property will be usable only by the API and hidden everywhere in the UI.

Input:

type string required

Property type (one of: site, resource, reservation, user)

id int required

Related ID whose property is being queried (depending on type one of: site ID, resource ID, reservation ID, user ID)

name string required

Property name

method string required

must be set to get_custom_property

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:

value string

Property value. NULL is returned if property with given name is not found

API playground:

Click here to test this function in the API playground.