GET List WordPress Users​
GET
/users
Retrieve a list of WordPress users filtered by role. Returns user ID, display name, and email by default. Useful for previewing users before importing them as contacts.
Authorizations​
ApplicationPasswords
WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password
Type
API Key (header: Authorization)
Parameters​
Query Parameters
roles[]
WordPress user roles to filter by.
Type
array
limit
Maximum number of users to return.
Type
integer
Default
5fields[]
User fields to include in the response.
Type
array
Default
"ID""display_name""user_email"Responses​
List of WordPress users.
application/json
JSON
{
"users": [
{
"ID": 0,
"display_name": "string",
"user_email": "string"
}
],
"total": 0
}