WordPress REST API: Get User Data - Guide

Here’s a quick guide to using the WordPress REST API for user data:

The WordPress REST API lets you access and manipulate WordPress data remotely
Key endpoints for user data:
- /wp-json/wp/v2/users – Get list of users
- /wp-json/wp/v2/users/<id> – Get specific user
- /wp-json/wp/v2/users/me – Get current user

Task	Endpoint	Example
Get all users	`/wp-json/wp/v2/users`	`/wp-json/wp/v2/users?per_page=10`
Get specific user	`/wp-json/wp/v2/users/<id>`	`/wp-json/wp/v2/users/1`
Search users	`/wp-json/wp/v2/users?search=<term>`	`/wp-json/wp/v2/users?search=john`
Filter by role	`/wp-json/wp/v2/users?role=<role>`	`/wp-json/wp/v2/users?role=editor`

Authentication required for most user data requests
Use parameters to filter results (e.g. orderby, order, per_page)
Responses are in JSON format
Handle errors by checking status codes and messages
Cache responses to improve performance
Follow security best practices when working with user data

Basics of the WordPress REST API

Definition of REST API

REST API is a way to design web applications. It uses:

Resources (identified by URIs)
Standard operations to work with these resources
Stateless communication
Caching for better performance

For WordPress, the REST API lets developers access and change WordPress data from outside the site.

How WordPress uses REST API

WordPress REST API works like this:

Feature	Description
Endpoints	Specific URLs to access different types of data
Namespaces	Organize endpoints (e.g., `wp/v2` for core data)
Data types	Posts, pages, users, and more
Integration	Used by WordPress core, plugins, and themes

The WordPress Block Editor also uses this API to talk to WordPress sites.

Advantages of the WordPress REST API

Here’s why the WordPress REST API is useful:

Advantage	Description
Easy to use	Simple way to work with WordPress data
Works at scale	Can handle lots of data and traffic
Standard rules	Follows common practices, making it easier to learn
Custom apps	Lets developers build their own tools that work with WordPress

Getting started

WordPress setup needs

To use the WordPress REST API, you need:

A WordPress site (version 4.7 or later)
The REST API active (check for /wp-json/ in Permalinks settings)

Ways to authenticate

Authentication is key for using the WordPress REST API. Here are the main methods:

Method	Description
Cookie authentication	Default method, works when logged into WordPress
Basic authentication	Uses an application password
Authentication plugins	Offer extra methods like OAuth

Required permissions

To get user data, you need the right permissions:

The read permission for the users endpoint
Permissions vary based on the endpoint and data type

Getting user data with REST API

This section covers how to fetch user data using the WordPress REST API. We’ll look at endpoints, fields, and ways to filter the data.

User data endpoints

There are two main endpoints for getting user data:

Endpoint	Description
`/wp-json/wp/v2/users`	Returns a list of users
`/wp-json/wp/v2/users/me`	Returns data for the current user

To get data for a specific user, add their ID to the first endpoint. For example: /wp-json/wp/v2/users/1 gets data for user with ID 1.

User data fields

You can choose which user data fields to include in the API response. Common fields are:

Field	Description
`id`	User’s ID
`name`	User’s name
`email`	User’s email address
`username`	User’s username
`roles`	User’s roles

To get specific fields, use the fields parameter in your request. For example:

/wp-json/wp/v2/users?fields=id,name,email

This returns only the id, name, and email fields for each user.

Filtering and sorting options

You can filter and sort user data using these parameters:

Parameter	Description
`search`	Find users by name or email
`orderby`	Sort users by a specific field
`order`	Set the sort order (ascending or descending)

Here’s an example that uses these parameters:

/wp-json/wp/v2/users?search=john&orderby=name&order=asc

This finds users with "john" in their name or email, sorted by name in ascending order.

Getting data for one user

This section explains how to fetch data for a single user using the WordPress REST API.

Single user endpoint

To get data for one user, use this endpoint:

/wp-json/wp/v2/users/USER_ID

Replace USER_ID with the ID of the user you want to fetch. For example, to get data for user with ID 1:

/wp-json/wp/v2/users/1

Settings for the request

You can customize your request with these settings:

Setting	Description	Example
`fields`	Choose which user data fields to include	`?fields=name,email`
`include`	Specify fields to include or exclude	`?include=id,name,email`

Example: Get only the name and email for user with ID 1:

/wp-json/wp/v2/users/1?fields=name,email

Understanding API responses

The API sends back user data in JSON format. Here’s what a response might look like:

{
  "id": 1,
  "name": "John Doe",
  "email": "[email protected]"
}

You can use this data in your website or app to show user information.

Getting data for many users

This section explains how to get information about multiple users using the WordPress REST API.

Multiple user endpoint

To get data for many users, use this endpoint:

/wp-json/wp/v2/users

This gives you a list of all users on your WordPress site. You can change what you get by adding extra information to the URL.

Managing large result sets

If you have many users, you might get too much information at once. To fix this, you can use pagination:

/wp-json/wp/v2/users?page=1&per_page=10

This gives you the first 10 users. You can then ask for more pages to see the rest.

Sorting and filtering

You can sort and filter user data in different ways:

Action	Example
Sort users by name	`/wp-json/wp/v2/users?orderby=name&order=asc`
Get only administrators	`/wp-json/wp/v2/users?role=administrator`

You can also mix these options. For example, to get all administrators sorted by name:

/wp-json/wp/v2/users?role=administrator&orderby=name&order=asc

Using these options helps you get just the user data you need.

User metadata

What is user metadata?

User metadata is extra information about users in WordPress. It’s stored in the wp_usermeta table in the WordPress database. This data helps:

Make user profiles more detailed
Save user preferences
Add new features to your WordPress site

Getting custom user fields

To get custom user fields with the WordPress REST API:

Use this endpoint: /wp-json/wp/v2/users/<user_id>
The response will have an array of metadata fields

Example: To get a user’s "twitter_account" field:

GET /wp-json/wp/v2/users/<user_id>?meta=twitter_account

Adding and updating metadata

To add or update user metadata:

Use this endpoint: POST /wp-json/wp/v2/users/<user_id>
Put the metadata in the request body

Example: To update a user’s "twitter_account":

POST /wp-json/wp/v2/users/<user_id>
{
  "meta": {
    "twitter_account": "https://twitter.com/username"
  }
}

Note	Description
Authentication	You must log in to the WordPress REST API
Permissions	You need the right permissions to change user metadata

Advanced user data tasks

How to search users

To find users in WordPress, you can use the REST API. Here’s how:

Make a GET request to /wp-json/wp/v2/users
Add search terms to the URL

Examples:

Search Type	URL
Email	`/wp-json/wp/v2/[email protected]`
Username	`/wp-json/wp/v2/users?search=johndoe`
Name	`/wp-json/wp/v2/users?search=John Doe`
Role	`/wp-json/wp/v2/users?role=editor`

Filtering by role or ability

You can filter users by their role or what they can do:

Filter Type	URL Example
Role	`/wp-json/wp/v2/users?role=editor`
Ability	`/wp-json/wp/v2/users?capability=edit_posts`

You can also mix filters:

/wp-json/wp/v2/users?role=editor&capability=edit_posts

This finds editors who can edit posts.

Finding users by specific traits

To find users with certain traits:

Use custom fields to store extra info
Search these fields with the API

Example:

If you have a field called "location", you can search it like this:

/wp-json/wp/v2/users?meta_key=location&meta_value=New York

You can search multiple traits at once:

/wp-json/wp/v2/users?meta_key=location&meta_value=New York&meta_key=interests&meta_value=coding

This finds users in New York who like coding.

Working with API responses

API response format

When you ask the WordPress REST API for information, it answers in JSON format. JSON is easy for computers to read and is used a lot in web development. The answer includes the data you asked for, plus some extra details like how many items there are and links to other pages of results.

Here’s what an answer might look like:

{
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "[email protected]"
    },
    {
      "id": 2,
      "name": "Jane Doe",
      "email": "[email protected]"
    }
  ],
  "total": 2,
  "total_pages": 1,
  "links": {
    "self": "https://example.com/wp-json/wp/v2/users?page=1",
    "next": null,
    "prev": null
  }
}

Dealing with errors

Sometimes, your request to the API might not work. This can happen for different reasons, like wrong login details or asking for something that doesn’t exist. When this happens, the API will tell you there’s a problem.

Here’s what an error message might look like:

{
  "code": "rest_invalid_request",
  "message": "Invalid request",
  "data": {
    "status": 400
  }
}

To handle errors, check the status code and error message. This will help you find out what went wrong and fix it.

Using the retrieved data

After you get data from the WordPress REST API, you can use it in your project. Here are some ways you might use the data:

Use Case	Example
Show users	Display a list of users with links to their profiles
Count users	Find out how many users have a certain role
Update profiles	Use the data to fill in user profile forms
Send emails	Use email addresses to contact users

Tips and best practices

Making efficient API requests

To use the WordPress REST API well and avoid slowing down your server, try these tips:

Tip	Description
Use caching	Store API responses for a short time to reduce server requests
Choose specific endpoints	Use endpoints that give only the data you need
Limit requests	Set a maximum number of API requests to prevent overload

Caching user data

Storing user data temporarily can help your site run faster. Here’s how:

Method	How it works
WordPress transients	Save API responses for a set time
Browser caching	Keep user data in the browser to reduce server requests
Set expiration times	Choose how long to keep cached data before updating

Keeping user data safe

When working with user information, safety is key. Follow these steps:

Step	Why it’s important
Use proper login methods	Ensure only allowed users can see user data
Check and clean input data	Stop harmful code from getting into your site
Use HTTPS	Keep data safe when it moves between users and your site

Fixing common problems

When using the WordPress REST API, you might run into some issues. Here’s how to fix the most common ones:

If you can’t log in:

Check your username and password
Make sure you’re using the right login method
Use the correct endpoint URL
Try resetting your password
Look at your server’s error logs for clues

Permission errors

If you get permission errors:

Check if your user role can do what you’re trying to do
Look at your WordPress settings and plugins
Try a different login method
Check your server’s error logs

Dealing with API limits

To avoid hitting API limits:

Tip	How to do it
Use caching	Save API answers for a short time
Pick specific endpoints	Only ask for the data you need
Limit requests	Set a max number of API calls

These tips will help you use the API without overloading it.

Using user data in WordPress

Showing user data in themes

You can use the WordPress REST API to get user data and show it in your theme. Here’s how:

Use the API endpoint to get user data
Display the data in your theme template

Here’s an example:

<?php
$user_id = 1; // Change this to the user ID you want
$url = 'https://yourwebsite.com/wp-json/wp/v2/users/'. $user_id;
$response = wp_remote_get( $url );
$user_data = json_decode( $response['body'], true );

// Show user data in your theme
echo '<p>User Name: '. $user_data['name']. '</p>';
echo '<p>User Email: '. $user_data['email']. '</p>';
?>

Using user data in plugins

Plugins can also use the WordPress REST API to get and use user data. Here’s an example:

<?php
function get_user_data( $user_id ) {
    $url = 'https://yourwebsite.com/wp-json/wp/v2/users/'. $user_id;
    $response = wp_remote_get( $url );
    $user_data = json_decode( $response['body'], true );
    return $user_data;
}

// Use the function to get user data
$user_id = 1; // Change this to the user ID you want
$user_data = get_user_data( $user_id );

// Use the data in your plugin
echo '<p>Hello, '. $user_data['name']. '! </p>';
?>

Making custom user data endpoints

Sometimes, you might need to make your own endpoints to get specific user data. Here’s how to do it:

<?php
function custom_register_user_meta_endpoint() {
    register_rest_route( 'custom/v1', '/user-meta/(?P<id>\\d+)', array(
        'methods' => 'GET',
        'callback' => 'custom_get_user_meta',
        'permission_callback' => function() {
            return current_user_can( 'edit_posts' );
        }
    ) );
}
add_action( 'rest_api_init', 'custom_register_user_meta_endpoint' );

function custom_get_user_meta( $data ) {
    $user_id = $data['id'];
    $user_meta = get_user_meta( $user_id );
    return array(
        'ID' => $user_id,
        'user_login' => $user_meta['user_login'],
        'user_email' => $user_meta['user_email'],
        'meta' => $user_meta,
    );
}
?>

This code makes a new endpoint that gives you user metadata.

Wrap-up

Main points covered

This guide explained how to use the WordPress REST API to get user data. We talked about:

What the WordPress REST API is and why it’s useful
How to set it up and log in
Different ways to get user information
How to work with user metadata
Tips for using the API well
How to fix common problems

We also looked at how to use the API in themes and plugins, and how to make your own endpoints for getting user data.

What’s next for WordPress REST API

The WordPress REST API keeps getting better. We can expect:

New features that make it easier to use
More plugins and themes using the API
New ways to build websites and apps with WordPress

As developers, it’s good to keep learning about the API. This helps us make better websites and apps that work well and keep user data safe.

Future of WordPress REST API
New features
More plugins and themes
New ways to build websites

FAQs

How to get data from rest API in WordPress?

To get data from the WordPress REST API:

Send an HTTP GET request to an API endpoint
Use a tool that supports HTTP requests (e.g., JavaScript Fetch, cURL in WP-CLI)
Process the JSON data you receive

Step	Description
Authentication	Use cookie authentication, OAuth, or JWT
Permissions	Make sure you have the right to access the data
Error handling	Check for issues if your request fails

Here’s a simple example using PHP:

<?php
$response = wp_remote_get('https://yoursite.com/wp-json/wp/v2/posts');
$posts = json_decode(wp_remote_retrieve_body($response), true);

foreach ($posts as $post) {
    echo $post['title']['rendered'] . '<br>';
}
?>

If you run into problems:

Look at the WordPress REST API docs
Check troubleshooting guides
Ask for help in WordPress forums

WordPress REST API: Get User Data – Guide

Related video from YouTube