PRpressable
sites

WordPress User List

This endpoint retrieves a list of WordPress users from your site.

get/sites/{id}/wordpress/users

Request

Path parameters

idinteger required

Query parameters

pageinteger
per_pageinteger

Response

Successful Response

messagestring
dataobject

Example response

{
  "message": "Success",
  "data": {
    "users": [
      {
        "id": 1,
        "user_login": "john.doe",
        "display_name": "john.doe",
        "user_email": "johndoe@example.com",
        "roles": "administrator"
      },
      {
        "id": 8,
        "user_login": "jane.doe",
        "display_name": "jane.doe",
        "user_email": "janedoe@example.com",
        "roles": "administrator, subscriber"
      }
    ],
    "total_user_count": 2,
    "per_page": 20,
    "page": 1,
    "table_prefix": "wp_",
    "user_table": "wp_users",
    "user_meta_table": "wp_usermeta",
    "capabilities_meta_key": "wp_capabilities"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.