Skip to content

louisnorthmore/BP-REST

 
 

Repository files navigation

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.9
  • BuddyPress >= 4.0.0

Endpoints (Components) Supported

  • Activity http:https://site.com/wp-json/buddypress/v1/activity
  • Groups http:https://site.com/wp-json/buddypress/v1/groups
  • Group Membership http:https://site.com/wp-json/buddypress/v1/groups/<group_id>/members
  • Group Invites http:https://site.com/wp-json/buddypress/v1/groups/<group_id>/invites
  • XProfile Fields http:https://site.com/wp-json/buddypress/v1/xprofile/fields
  • XProfile Groups http:https://site.com/wp-json/buddypress/v1/xprofile/groups
  • XProfile Data http:https://site.com/wp-json/buddypress/v1/xprofile/<field_id>/data/<user_id>
  • Members http:https://site.com/wp-json/buddypress/v1/members
  • Notifications http:https://site.com/wp-json/buddypress/v1/notifications
  • Components http:https://site.com/wp-json/buddypress/v1/components

Endpoints (Components) Partly Supported

  • Messages http:https://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.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.

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

About

A RESTful API, for BuddyPress

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 98.8%
  • Shell 1.2%