API Playground - search_users_by_custom_property

search_users_by_custom_property


Finds all users whose custom user property has the specified value. This function will return max 500 users. (click for full documentation)

property_name

Custom user property (with no prefix)

property_value

Property value. It can include star (*) to match a pattern, e.g. abc* would match both abc and abcdef.

detail_level

Sum of one or more of the following integers (ORed value): 1=user info, 2=user properties. Default value is 1.

language

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

your API key - Click here to get your key
* - påkrevd felt