API - Planyo Web Services - get_user_data

You are here: Planyo » Help » API » get_user_data



Returns details of a user. The users which can be found are those who made at least one reservation, were created by the admins, or they must administer the site (as main administrator, resource admin or moderator). You must pass either the email address or the user ID.


user_id int optional
ID of the user
email string optional
Email address of the user
site_id int optional
Optional and used only with metasite-level api keys and when detail_level includes custom user properties. Sets the context of a single site for the returned custom user properties.
detail_level int optional
Sum of one or more of the following integers (ORed value): 1=user information, 4=custom user properties, 8=info about the reservations made by the user, 16=preapproval/banned status information. Default value is 1 (all user information without custom properties).
method string required
must be set to get_user_data
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.


login string
User's login name
id int
User ID
email string
User's email address
registration_time DateTime
Time of registration or entry into the system
is_email_verified bool
Returns true if user's email has been verified or false otherwise.
first_name string
User's first name
last_name string
User's last name
address string
User's address
city string
User's city
zip string
Zip or postal code
state string
State or province
country string
Two-letter country code (ISO 3166-1 alpha-2)
language string
Two-letter language code (e.g. EN, DE, FR etc.)
phone_number string
Phone number (including country code)
reservation_count int
Number of reservations made by the customer. Returned only when requested in detail_level
mobile_number string
Mobile number (including country code)
properties array
If you requested custom user properties to be returned (using detail_level), then they will be returned in here.

API playground:

Click here to test this function in the API playground.