1. Home
  2. WP User
  3. REST API
  4. List Users

List Users

EndPoint

Endpoint : wp-json/wpuser/v1/users

Method : GET

Users are accessible through the WordPress REST API at the  /wpuser/ endpoint.

To list user, send a GET request to the wp-json/wpuser/v1/users  endpoint

Example Request 

http://localhost/wpuserplus/wp-json/wpuser/v1/users

Arguments

pageCurrent page of the collection.Default: 1
per_pageMaximum number of items to be returned in result set.Default: 10
approveReturn only Approved users.
excludeEnsure result set excludes specific IDs.
includeLimit result set to specific IDs.
orderOrder sort attribute ascending or descending.Default: ascOne of: ascdesc
orderbySort collection by object attribute.Default: registeredOne of: idincludename, registered, emailurl
role_not_inExclude users who have any of the specified roles. . array().
role_inLimit the returned users that have one of the specified roles. array().
Was this article helpful to you? Yes No