search_all_users
This endpoint will search the database user table field and compare meta_key from user_meta table.
For instance, if you want to search user_email and compare it to similar nickname from user_meta, you can use this endpoint.
Resource URL
https://localhost/api/userplus/search_all_users/Method
POST
Required Parameters
- key – get API key from Settings > User Plus
- secret – get API secret from Settings > User Plus
- field - Required. Any user table field to match with meta_key. Possible values for 'field' variable are 'user_email', 'user_login', 'user_nicename', 'display_name'.
- meta_key - Required. Any meta_key to match with field value. such as nickname
Optional Parameters
- order_by - Optional. default: ID; possible values: ID, user_login, display_name, user_nicename, user_created, user_email.
- order - Optional. default: ASC, possible values ASC, DESC
Endpoint Returns
A list of users and count of results..
Sample Request URL
https://localhost/api/userplus/search_all_users/?key=KEY-HERE&secret=SECRET_HERESample Response
{
"status": "ok",
"count": 3,
"users": [
{
"ID": "30",
"user_email": "aaa@par.com"
},
{
"ID": "18",
"user_email": "aaa@gmail.com"
},
{
"ID": "56",
"user_email": "zzz@gmail.com"
}
]
}