Skip to main content

Documentation

IMPORTANT

This is the outdated SI-documentation which will be adapted soon. A huge part may be obsolete!

Members Listing

Members Listing

In this section, we will briefly explain the REST API to retrieve the Member Listing.

This REST API call allows requester to list all members created on the site. To retrieve the list of members, requester will need to send a GET request to this following url:

http://site.com/index.php?option=com_easydiscuss&view=users&format=json&tmpl=component

GET Parameters

The following are the available parameters when a GET is made to this API call:

  • sort (optional)
    This sort parameter is optional and the default value is asc.

Response

Upon a successful request, EasyDiscuss system will return a response in a form of JSON to the requester.

The successful request response will looks similar as below:

{
  "users": [
    {
      "name": "Cameron Monaghan",
      "avatar": "http://easydiscuss.com/images/discuss_avatar/959_be2b950c7933d3188c43c0ba3f58e3e3.jpg",
      "permalink": "/index.php?option=com_easydiscuss&view=profile&id=967&Itemid=118",
      "description": "",
      "lastonline": "Tuesday, March 15 2016, 09:58 AM",
      "posts": "1",
      "replies": "0",
      "badges": "0"
    },
    {
      "name": "Emir Rastan",
      "avatar": "http://easydiscuss.com/images/discuss_avatar/959_9d25dc9fb9c01bd082fb5fe75c7c6a97.jpg",
      "permalink": "/index.php?option=com_easydiscuss&view=profile&id=963&Itemid=118",
      "description": "",
      "lastonline": "Friday, April 15 2016, 12:15 PM",
      "posts": "1",
      "replies": "0",
      "badges": "0"
    }
  ]
}
We use cookies
We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience. You can decide whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.