Default API endpoints in Wordpress

Introduction

Default API endpoints let you get or send data to your WordPress site easily. They help connect your site with other apps or websites without extra setup.

You want to show your blog posts on a mobile app.

You need to get user info from your site for another tool.

You want to update content on your site from an external program.

You want to list categories or tags on a custom website.

You want to check site data without logging into WordPress admin.

Syntax

Wordpress

/wp-json/wp/v2/{type}/{id}

{type} is the kind of content like posts, pages, or users.

{id} is optional and means a specific item number.

Examples

Gets a list of all blog posts.

Wordpress

/wp-json/wp/v2/posts

Gets the blog post with ID 10.

Wordpress

/wp-json/wp/v2/posts/10

Gets a list of all pages on the site.

Wordpress

/wp-json/wp/v2/pages

Gets a list of users (if allowed by permissions).

Wordpress

/wp-json/wp/v2/users

Sample Program

This JavaScript code fetches all posts from a WordPress site using the default API endpoint and prints them in the browser console.

Wordpress

fetch('https://example.com/wp-json/wp/v2/posts')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Important Notes

Default endpoints follow a standard URL pattern starting with /wp-json/wp/v2/.

Some data may require you to be logged in or have permissions.

You can add query parameters to filter or sort results, like ?per_page=5 to get 5 items.

Summary

Default API endpoints let you access WordPress data easily via URLs.

They use a simple pattern with content type and optional ID.

You can use them to connect your site with other apps or tools without extra coding.

Practice

1. What is the main purpose of WordPress default API endpoints?

easy

A. To allow easy access to WordPress data via URLs

B. To create custom themes automatically

C. To manage user roles and permissions

D. To optimize website SEO settings

Solution

1. Step 1: Understand what API endpoints do

   API endpoints provide a way to get or send data through URLs.

2. Step 2: Identify the role of default WordPress endpoints

   They let you access WordPress content like posts or users easily without extra coding.

3. Final Answer:

   To allow easy access to WordPress data via URLs -> Option A

4. Quick Check:

   Default API endpoints = easy data access [OK]

Hint: Default API endpoints = easy data access URLs [OK]

Common Mistakes:

• Thinking endpoints create themes
• Confusing endpoints with user management
• Assuming endpoints handle SEO

2. Which of the following is the correct default REST API endpoint URL to get all posts in WordPress?

easy

A. /wp-content/posts

B. /wp-admin/posts

C. /api/v1/posts/all

D. /wp-json/wp/v2/posts

Solution

1. Step 1: Recall the WordPress REST API base URL

   The base URL for WordPress REST API is /wp-json/wp/v2/.

2. Step 2: Identify the correct endpoint for posts

   The posts endpoint is posts, so full URL is /wp-json/wp/v2/posts.

3. Final Answer:

   /wp-json/wp/v2/posts -> Option D

4. Quick Check:

   Posts endpoint = /wp-json/wp/v2/posts [OK]

Hint: WordPress REST API base = /wp-json/wp/v2/ [OK]

Common Mistakes:

• Using admin URLs instead of API URLs
• Confusing API version or path
• Using incorrect folder paths

3. What will be the result of accessing the URL /wp-json/wp/v2/posts/10 in a WordPress site?

medium

A. Returns the post with ID 10 in JSON format

B. Returns a list of all posts except post 10

C. Returns an error because ID is not allowed

D. Redirects to the homepage

Solution

1. Step 1: Understand the endpoint pattern

   The URL /wp-json/wp/v2/posts/{id} fetches a single post by its ID.

2. Step 2: Interpret the given URL

   Here, ID is 10, so it returns the post with ID 10 in JSON format.

3. Final Answer:

   Returns the post with ID 10 in JSON format -> Option A

4. Quick Check:

   Single post URL returns that post [OK]

Hint: URL with /posts/{id} returns that post [OK]

Common Mistakes:

• Thinking it returns all posts except one
• Assuming ID is invalid in URL
• Expecting a redirect instead of JSON

4. You try to fetch users data using /wp-json/wp/v2/users but get a 401 Unauthorized error. What is the likely cause?

medium

A. The URL is missing the API version

B. The users endpoint does not exist in WordPress

C. You need proper authentication to access users endpoint

D. You must use GET method instead of POST

Solution

1. Step 1: Check endpoint access rules

   Users endpoint requires authentication because user data is sensitive.

2. Step 2: Analyze the error 401 Unauthorized

   This error means the request lacks valid credentials to access the resource.

3. Final Answer:

   You need proper authentication to access users endpoint -> Option C

4. Quick Check:

   401 error = authentication needed [OK]

Hint: 401 error means login/auth needed [OK]

Common Mistakes:

• Thinking users endpoint is missing
• Assuming URL version is wrong
• Confusing HTTP methods

5. You want to get all published posts with the category ID 5 using the default WordPress REST API. Which URL should you use?

hard

A. /wp-json/wp/v2/posts?category=5&status=published

B. /wp-json/wp/v2/posts?categories=5&status=publish

C. /wp-json/wp/v2/posts?cat=5&post_status=publish

D. /wp-json/wp/v2/posts?categories=5&post_status=published

Solution

1. Step 1: Identify correct query parameters for category and status

   WordPress REST API uses categories for category IDs and status for post status.

2. Step 2: Match parameters with correct values

   Category ID is 5, and published posts use status=publish.

3. Final Answer:

   /wp-json/wp/v2/posts?categories=5&status=publish -> Option B

4. Quick Check:

   categories=5 and status=publish are correct params [OK]

Hint: Use categories=ID and status=publish for filtering posts [OK]

Common Mistakes:

• Using wrong parameter names like category or cat
• Using status=published instead of publish
• Mixing post_status with status