Actions17
User → Get Many
AI-generatedSummary
Fetches a list of WordPress users from the REST API, optionally filtering by search term, sorting criteria, or author status.
Inputs
- returnAll — If true, fetches all users; otherwise, limits results to the specified maximum.
- limit — Maximum number of users to return when Return All is disabled. Range: 1 to 10.
- options — Collection of query parameters for filtering and sorting the user list.
- options.context — Scope of the request ('view', 'embed', or 'edit'), determining which fields are returned.
- options.order — Sort direction ('asc' or 'desc'). Default: 'desc'.
- options.orderBy — Attribute to sort by ('id', 'name', 'email', 'slug', 'registered_date', 'include', 'include_slugs', 'url'). Default: 'id'.
- options.search — String to match against user names or emails.
- options.who — Limit results to users considered authors ('authors'). Default: 'authors'.
Output shape
A list of user objects (items).
When Return All is enabled, the node handles pagination automatically (default page size: 10).
Examples
Example 1: Retrieve the first 5 users sorted by name in descending order.
Return All: false, Limit: 5, Order By: name, Order: desc
Example 2: Fetch all registered authors.
Return All: true, Order By: id, Who: authors
Example 3: Find users with email addresses containing 'example.com'.
Return All: false, Limit: 5, Search: example.com