Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

BuddyPress RESTful API

Access your BuddyPress site's data through an easy-to-use HTTP REST API.

Documentation

We have extensive documentation of each endpoint/components and their CRUD actions: https://developer.buddypress.org/bp-rest-api/

System Requirements

  • PHP >= 5.6
  • WP >= 4.9
  • BuddyPress >= 6.0.0

Endpoints (Components) Supported

  • Activity http://site.com/wp-json/buddypress/v1/activity
  • Groups http://site.com/wp-json/buddypress/v1/groups
  • Group Membership http://site.com/wp-json/buddypress/v1/groups/<group_id>/members
  • Group Membership Request(s) http://site.com/wp-json/buddypress/v1/groups/{group_id}/membership-request/
  • Group Avatar http://site.com/wp-json/buddypress/v1/groups/<group_id>/avatar
  • Group Cover http://site.com/wp-json/buddypress/v1/groups/<group_id>/cover
  • Group Invites http://site.com/wp-json/buddypress/v1/groups/<group_id>/invites
  • XProfile Fields http://site.com/wp-json/buddypress/v1/xprofile/fields
  • XProfile Groups http://site.com/wp-json/buddypress/v1/xprofile/groups
  • XProfile Data http://site.com/wp-json/buddypress/v1/xprofile/<field_id>/data/<user_id>
  • Members http://site.com/wp-json/buddypress/v1/members
  • Members Profile Photo (aka Avatar) http://site.com/wp-json/buddypress/v1/members/<user_id>/avatar
  • Members Cover http://site.com/wp-json/buddypress/v1/members/<user_id>/cover
  • Notifications http://site.com/wp-json/buddypress/v1/notifications
  • Components http://site.com/wp-json/buddypress/v1/components
  • Messages http://site.com/wp-json/buddypress/v1/messages
  • Signup http://site.com/wp-json/buddypress/v1/signup
  • Friends http://site.com/wp-json/buddypress/v1/friends
  • Blogs http://site.com/wp-json/buddypress/v1/blogs
  • Blog Avatar http://site.com/wp-json/buddypress/v1/blogs/<id>/avatar

Installation

Drop this plugin in the wp-content/plugins directory and activate it. You need at least WordPress 4.9 and BuddyPress to use the plugin.

About

WordPress is moving towards becoming a fully-fledged application framework. BuddyPress can benefit from this new API by adding endpoints to access social data.

This plugin provides an easy to use REST API Endpoints for BuddyPress, available via HTTP. Grab your site's data in simple JSON format, including users, groups, xprofile and more. Retrieving or updating data is as simple as sending a HTTP request.

About

A RESTful API, for BuddyPress

Resources

Releases

No releases published

Packages

No packages published

Languages