This is an overview of all REST API endpoints provided by the free and PRO versions of the WP Synapse plugin.
Base URL:
https://YOUR-DOMAIN.com/wp-json/wp-synapse/v1/
All requests require a valid API key. Pass it as a URL parameter in every request.
Example: ?api_key=YOUR_KEY
Tests the connection to the website and the validity of the API key.
/test
Requires any valid API key.
{
"success": true,
"message": "Connection successfully established.",
"plugin_version": "1.0.0",
"execution_time_ms": 12
}Retrieves a combined overview of the most important data points (updates, health, moderation) in a single request.
/summary
Requires the scope read_data.
{
"updates": {
"plugins": [
{
"name": "Akismet Anti-Spam",
"file": "akismet/akismet.php",
"current_version": "5.0",
"new_version": "5.1"
}
],
"themes": [],
"wordpress": [],
"update_count": 1,
"execution_time_ms": 125
},
"health": {
"overall_status": "Good",
"overall_status_key": "good",
"passed_checks": 12,
"issues_count_critical": 0,
"issues_count_recommended": 0,
"issues_list": [],
"check_results": {
"core_update_available": false,
"server_response_time_ms": 210,
"server_response_status": "good"
},
"login_url": "https://example.com/wp-login.php",
"execution_time_ms": 89
},
"moderation": {
"pending_comments": 0,
"pending_posts": 1,
"execution_time_ms": 15
},
"execution_time_ms": 250
}Retrieves an overview of all available updates for the WordPress core, plugins, and themes.
/updates
Requires the scope read_data.
Create a daily workflow (e.g., in n8n) that checks for available updates. If so, it sends you a notification in Slack or Discord. This way, you'll never miss an important security update again without having to log in daily.
Have an email automatically generated every Monday morning with a list of all upcoming updates. This allows you to plan and perform your maintenance for the week at a time that best suits you.
{
"plugins": [
{
"name": "Akismet Anti-Spam",
"file": "akismet/akismet.php",
"current_version": "5.0",
"new_version": "5.1"
}
],
"themes": [],
"wordpress": [
{
"current_version": "6.8.0",
"new_version": "6.8.1",
"update_type": "upgrade"
}
],
"update_count": 2,
"execution_time_ms": 125
}Performs a series of security and performance checks and returns a summary of the website's health.
/site-health
Requires the scope read_data.
Set up an automation that monitors the overall_status_key. As soon as it changes to "critical" (e.g., due to a server issue), you'll receive an immediate push notification to your smartphone. This way, you'll be the first to know about critical issues – often before your visitors even notice.
Log the server_response_time_ms value daily in a Google Sheet. This will create a meaningful graph of your hosting's performance over time and allow you to objectively measure the impact of optimization measures.
{
"overall_status": "Improvements recommended",
"overall_status_key": "recommended",
"passed_checks": 10,
"issues_count_critical": 0,
"issues_count_recommended": 2,
"issues_list": [
{
"label": "Inactive plugins found",
"description": "...",
"status": "recommended"
}
],
"check_results": {
"core_update_available": false,
"php_version_ok": true,
"https_active": true,
"inactive_plugins_count": 2,
"backup_plugin_active": true,
"admin_user_exists": false,
"server_response_time_ms": 350,
"server_response_status": "good"
},
"login_url": "https://example.com/wp-login.php",
"execution_time_ms": 89
}Retrieves the number of pending comments and posts for moderation.
/moderation
Requires the scope read_data.
If your blog receives a lot of comments, a workflow can automatically create a new task in Trello or Asana whenever a comment is due for approval. This ensures no interaction is lost and the community remains engaged.
For guest posting sites, this endpoint can send a notification to the editor-in-chief once a new post is submitted for review, speeding up the publishing process.
{
"pending_comments": 5,
"pending_posts": 1,
"execution_time_ms": 15
}Returns the timestamps of the last core activities on the website.
/activity
Requires the scope read_data.
Set up a personal dashboard (e.g., with Geckoboard) that displays the last_post_publish_gmt timestamp. A simple but effective motivator to publish new content regularly.
Monitor the last_user_login_gmt. If you're the only user and a login occurs at an unusual time, a security alert can be automatically triggered to your email address.
{
"last_post_publish_gmt": "2025-09-01 10:00:00",
"last_comment_approved_gmt": "2025-09-02 14:30:00",
"last_user_login_gmt": "2025-09-03 08:15:00",
"execution_time_ms": 25
}Retrieves either a summary of all users or detailed information about a single user.
/users
/users/{id}
Requires the scope read_users.
id (optional): The ID of the user whose data should be retrieved.
Create automated monthly reports for your clients. Pull the total_users value to document community growth on the client website and demonstrate the value of your work.
Link user data with the data from /activity. This allows you to quickly find out for a client which editor has written how many posts and when they were last active.
{
"total_users": 15
}{
"id": 1,
"username": "admin",
"email": "admin@example.com",
"display_name": "Administrator",
"registered_gmt": "2025-01-01 00:00:00",
"last_login_gmt": "2025-09-05 12:00:00",
"post_count": 50,
"page_count": 10
}Returns a list of users who have not logged in for a certain period of time.
/inactive-users
Requires the scope read_users.
days (optional): Number of days of inactivity. Default: 90.
role (optional): Filters by a specific user role (e.g., "subscriber").
Offer a "Security & Compliance" service. Conduct a quarterly automated scan of all customer websites to identify administrator accounts that have been inactive for more than 90 days and report them as potential security risks.
Run a monthly check for users with the role "customer" who have been inactive for over 180 days. Feed this list into your marketing automation tool to trigger a re-engagement campaign with a special discount coupon, bringing back past customers and boosting revenue.
For large membership sites, use this endpoint to identify "dead accounts" (e.g., subscribers inactive for 2 years). Exporting and cleaning up this list can noticeably improve website performance.
{
"count": 1,
"days_inactive": 90,
"role_filter": "all",
"users": [
{
"id": 2,
"username": "testuser",
"email": "test@example.com",
"display_name": "Test User",
"last_login_gmt": "2025-05-10 18:00:00"
}
],
"execution_time_ms": 45
}Returns a list of posts and pages that have not been updated for a certain period of time.
/stale-content
Requires the scope read_content.
days (optional): Number of days since the last modification. Default: 365.
This is a cash cow. Offer a "Content Refresh" service. Scan a new client's website and present them with a list of all blog posts that haven't been updated in over 18 months as a concrete, data-backed SEO opportunity.
Monitor the content of your top clients. If you notice that important "cornerstone" content is becoming outdated, you can proactively approach the client and suggest a revision, strengthening your position as a strategic partner.
{
"count": 1,
"days_stale": 365,
"posts": [
{
"id": 12,
"title": "An Old Blog Post",
"post_type": "post",
"last_modified": "2024-01-20 10:00:00",
"link": "https://example.com/an-old-blog-post/",
"author_id": 1
}
],
"execution_time_ms": 60
}Runs all pending plugin updates, or a specific selection.
/updates/plugins
Requires the scope execute_updates.
To update only specific plugins, pass a JSON object with an array of plugin identifiers (file).
This endpoint is part of the monitoring feature in the PRO version but can also be used in the FREE-Version and is a tremendous time saver. It allows administrators to trigger plugin and theme updates on a monitored WordPress instance directly from their monitoring dashboard, without having to log in to the instance. Triggering selective updates can also be integrated into custom workflows.
Integrate this endpoint into a larger workflow. After a successful backup of your website (verified by another tool), WP Synapse can automatically initiate all updates.
{
"plugins": [
"akismet/akismet.php",
"hello-dolly/hello.php"
]
}{
"success": true,
"message": "Plugin updates completed successfully.",
"details": {
"akismet/akismet.php": true
}
}Runs all pending theme updates, or a specific selection.
/updates/themes
Requires the scope execute_updates.
To update only specific themes, pass a JSON object with an array of theme identifiers (stylesheet).
This endpoint is part of the monitoring feature in the PRO version but can also be used in the FREE-Version and is a tremendous time saver. It allows administrators to trigger plugin and theme updates on a monitored WordPress instance directly from their monitoring dashboard, without having to log in to the instance. Triggering selective updates can also be integrated into custom workflows.
Integrate this endpoint into a larger workflow. After a successful backup of your website (verified by another tool), WP Synapse can automatically initiate all updates.
{
"themes": [
"twentytwentyfour"
]
}{
"success": true,
"message": "Theme updates completed successfully.",
"details": {
"twentytwentyfour": true
}
}Runs the pending WordPress core update.
/updates/core
Requires the scope execute_updates.
This endpoint is part of the monitoring feature in the PRO version but can also be used in the FREE-Version and is a tremendous time saver. It allows administrators to trigger WordPRess core updates on a monitored WordPress instance directly from their monitoring dashboard, without having to log in to the instance. It can also be integrated into custom workflows.
Integrate this endpoint into a larger workflow. After a successful backup of your website (verified by another tool), WP Synapse can automatically initiate all updates.
{
"success": true,
"message": "WordPress core was successfully updated.",
"details": "WordPress updated successfully"
}Performs a complex search for posts or pages based on various criteria passed in the request body.
/search
Requires the scope read_content.
A JSON object that can contain WP_Query arguments such as post_type, author__in, or tax_query.
A customer asks: "Show me all the articles our new editor 'John Doe' wrote on 'sustainability' in the last quarter." Instead of a manual search, a single API request with author__in and tax_query immediately delivers the exact list.
You're planning a relaunch and need to find all pages that contain a specific shortcode. A POST request to the /search endpoint can provide this list in seconds, massively simplifying planning and effort estimation.
{
"post_type": ["post"],
"author__in": [1, 3],
"tax_query": {
"relation": "AND",
"queries": [
{
"taxonomy": "category",
"field": "slug",
"terms": "tech"
}
]
}
}{
"count": 5,
"results": [
{
"id": 42,
"title": "New Tech Gadgets",
"post_type": "post",
"link": "https://example.com/new-tech-gadgets/",
"author_id": 1
}
],
"execution_time_ms": 110
}