Skip to content
A RESTful API, for BuddyPress
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Use Composer phpunit when running tests. Nov 21, 2018
includes Global: several fixes, updates and cleanup Mar 16, 2019
tests
.distignore More cleaning up and organizations Dec 7, 2017
.editorconfig
.gitignore Composer setup. Nov 20, 2018
.travis.yml
CONTRIBUTING.md
README.md
bp-rest.php Group Avatar: refactor and clean up Mar 9, 2019
composer.json
package.json
phpunit.xml.dist
readme.txt minor changes Mar 2, 2019

README.md

BuddyPress RESTful API

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

Build Status

The current endpoints are pretty much in flux, as we work toward adding and updating them.

Please use and provide feedback!

System Requirements

  • PHP >= 5.6
  • WP >= 4.7
  • BuddyPress = trunk

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 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
  • Notifications http://site.com/wp-json/buddypress/v1/notifications
  • Components http://site.com/wp-json/buddypress/v1/components

Endpoints (Components) Partly Supported

  • Messages http://site.com/wp-json/buddypress/v1/messages

Endpoints (Components) Pending

  • Friends
  • Signups
  • Settings
  • Emails

Installation

Drop this plugin in the wp-content/plugins directory and activate it. You need at least WordPress 4.7 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.

There's no fixed timeline for integration into BuddyPress core at this time, the BP REST API will be available as a feature plugin!

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.