GET /wp-json/wp/v2/users

contextScope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
pageCurrent page of the collection.
Default: 1
per_pageMaximum number of items to be returned in result set.
Default: 10
searchLimit results to those matching a string.
excludeEnsure result set excludes specific IDs.
includeLimit result set to specific IDs.
offsetOffset the result set by a specific number of items.
orderOrder sort attribute ascending or descending.
Default: asc
One of: asc, desc
orderbySort collection by object attribute.
Default: name
One of: id, include, name, registered_date, slug, include_slugs, email, url
slugLimit result set to users with one or more specific slugs.
rolesLimit result set to users matching at least one specific role provided. Accepts csv list or single role.
whoLimit result set to users who are considered authors.
One of: authors

Servers

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.