Just like the WordPress REST API, the BP REST API is organized around REST, and is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. The API uses built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and supports cross-origin resource sharing to allow you to interact securely with the API from a client-side web application.

The BP REST API uses JSON exclusively as the request and response format, including error responses.

The BP REST API provides public data accessible to any client anonymously, as well as private data only available after authentication. Once authenticated the BP REST API supports most BuddyPress community actions, allowing you to enhance your plugins with more responsive management tools, or build complex single-page applications.

This API reference provides information on the specific endpoints available through the API, their parameters, and their response data format.

Developer Endpoint Reference

ResourceBase Route
Extended Profiles:
Profile Group
Profile Field
Profile Data

User Groups:
Group Membership
Group Membership Requests
Group Invites

Private Messaging:
Sitewide Notices
Screen Notifications/buddypress/v1/notifications
Member Avatar
Member Cover Image
Group Avatar
Group Cover Image
Blog Avatar

User Blogs/buddypress/v1/blogs
User Signups/buddypress/v1/signup
Friend Connections/buddypress/v1/friends