Playgroup community API

The Playgroup REST API for simple read and write actions from outside Playgroup.

Before using the API

You need a valid API key to be able to use the public API. The key is usually only available to the Playgroup owner. All content is delivered as JSON data. All writes return true or false.

Get all active users

A list of all currently registered users with their most interesting data:

Example request
GET
/api/v1/members
curl -L playgroup.community/api/v1/members?api_key=XXX-XXX-XXX\&domain=subdomain.playgroup.community
Available fields
  • name
  • role
  • avatar
  • bio
  • link
  • status
  • status_date
  • location
  • timezone
  • interests
  • facebook
  • instagram
  • twitter
  • spotify
  • youtube
  • linkedin
Response

{
  name: "...",
  role: "...",
  avatar: "...",
  bio: "...",
  link: "...",
  status: "...",
  status_date: "...",
  location: "...",
  timezone: "...",
  interests: "...",
  facebook: "...",
  instagram: "...",
  twitter: "...",
  spotify: "...",
  youtube: "...",
  linkedin: "..."
}

Get all channels

A list of all public and private channels in your Playgroup.

Example request
GET
/api/v1/channels
curl -L playgroup.community/api/v1/channels?api_key=XXX-XXX-XXX\&domain=subdomain.playgroup.community
Available fields
  • id
  • channel_name
  • slug
  • description
  • channel_image
  • public
Response

{
  id: "...",
  channel_name: "...",
  slug: "...",
  description: "...",
  channel_image: "...",
  public: "..."
}

Get all threads

A list of all public and private threads in your Playgroup.

Example request
GET
/api/v1/threads
curl -L playgroup.community/api/v1/threads?api_key=XXX-XXX-XXX\&domain=subdomain.playgroup.community
Available fields
  • subject
  • content
  • thread_slug
  • date
  • last_update
Response

{
  subject: "...",
  content: "...",
  thread_slug: "...",
  date: "...",
  last_update: "..."
}

Create a new thread

Create a complete thread in a channel of your choice. You'll need to look at the URL to get the channel_slug in which the thread should be posted.

Example request
POST
/api/v1/create/thread
curl -L playgroup.community/api/v1/create/thread?api_key=XXX-XXX-XXX\&domain=subdomain.playgroup.community\&subject=New%20thread%20title\&content=lorem%20ipsum%20dolor%20sit%20amet\&channel_slug=general\&user=ben
Available fields
  • subject*
  • content*
  • channel_slug*
  • user*
Response
"true" or "false"

Create a new channel

Create a new public channel, accessible to all members.

Example request
POST
/api/v1/create/channel
curl -L playgroup.community/api/v1/create/channel?api_key=XXX-XXX-XXX\&domain=subdomain.playgroup.community\&name=API%20created%20channel\&description=lorem%20ipsum%20dolor%20sit%20amet
Available fields
  • name*
  • description
  • channel_image
Response
"true" or "false"