API - Planyo Web Services - search_users_by_custom_property

You are here: Planyo » Help » API » search_users_by_custom_property



Finds all users whose custom user property has the specified value. This function will return max 500 users.


property_name string required
Custom user property (with no prefix)
property_value string required
Property value. It can include star (*) to match a pattern, e.g. abc* would match both abc and abcdef.
detail_level int optional
Sum of one or more of the following integers (ORed value): 1=user info, 2=user properties. Default value is 1.
method string required
must be set to search_users_by_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.


results array
Array whose items are named arrays with the following keys: id (user_id), first_name, last_name, email, address, state, city, zip, country, registration_date, language

API playground:

Click here to test this function in the API playground.