Search Viddler people (or Viddler users). This method can also be used to search through people that are active and also a Viddler user’s friends.

Note: Not all arguments are required, though some are required for certain query types. Please review all of the documentation.

Authenication

This method requires user authentication to search through a specific user’s friends but does not require authentication to search all Viddler users.

Arguments

method
Should be set to “viddler.users.search”
api_key
Assigned Viddler API Key
type
The type of search (e.g. “everybody”, “friends”, “active”.
query
What to search for (e.g. “New York City”, “Colin Devroe”, or “Photographers”)
page (optional)
The “page number” of results to retrieve (e.g. 1, 2, 3).
per_page (optional)
The number of results to retrieve per page (maximum 100). If not specified, the default value equals 20.
sessionid(optional)
The sessionid for a specific user’s account – only used for the “friends” type.

Example Call

http://www.viddler.com/rest/v1/?method=viddler.users.search&api_key=key&type=everybody&query=photography

Example People Search Response

This method returns a set of Viddler profiles.

<user_list total="XX">
<user>
<!-- same data as viddler.users.getProfile -->
</user>
<user>
    <!-- same data as viddler.users.getProfile -->
</user>
</user_list>
 
...

Error Codes

Standard errors apple. Also “missing required parameter” will be the response if type is myvideos or friendsvideos and no valid sessionid is provided.