Group

The Group object

The Group object looks like this in JSON:

{
    "object": "group",
    "id": 1,
    "parent_id": null,
    "name": "Seagulls, stop it now",
    "description": null,
    "membership": "open",
    "can_invite": "members",
    "can_bulletin_board_posts": "members",
    "can_add_discussions": "members",
    "can_upload_files": "members",
    "enable_chat": true,
    "public": true,
    "official": false,
    "image_file_id": null,
    "status": "active",
    "status_by_id": null,
    "status_at": null,
    "added_at": "2019-01-22T23:50:55+00:00",
    "added_by_id": 11,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
parent_id	No	int
name	Yes	text (300)
description	No	text
membership	Yes	enum (open, roles, invitation_only)
can_invite	Yes	enum (members, moderators, admins)
can_bulletin_board_posts	Yes	enum (members, moderators, admins)
can_add_discussions	Yes	enum (disabled, members, moderators, admins)
can_upload_files	Yes	enum (disabled, members, moderators, admins)
enable_chat	No	bool
public	No	bool
official	No	bool
image_file_id	No	int
status	Yes	enum (pending, active, denied)
status_by_id	No	int
status_at	No	datetime
added_at	No	datetime
added_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/groups" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"status","value":"BLAH","positive":1}]}}
}' \

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/groups',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/groups',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/groups"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/groups');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "group",
            "id": 1,
            "parent_id": null,
            "name": "Seagulls, stop it now",
            "description": null,
            "membership": "open",
            "can_invite": "members",
            "can_bulletin_board_posts": "members",
            "can_add_discussions": "members",
            "can_upload_files": "members",
            "enable_chat": true,
            "public": true,
            "official": false,
            "image_file_id": null,
            "status": "active",
            "status_by_id": null,
            "status_at": null,
            "added_at": "2019-01-22T23:50:55+00:00",
            "added_by_id": 11,
            "report_data": {
                "user_member_status": null,
                "user_member_type": null,
                "num_members": 0
            }
        }
    ],
    "sandbox": true
}

Retrieves all Group objects that match given filter conditions.

HTTP Request

GET /groups

Parameters

Name	Required	Data Type	Description
filter	No	mixed	See available filter conditions
page	No	int	The page of results to return if more than 200 records are found.

Expandable Properties

members
roles

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
search	text
status	enum

Permissions

Any role may call this method.

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/groups/(group)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/groups/(group)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/groups/(group)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/groups/(group)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/groups/(group)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "group",
    "id": 1,
    "parent_id": null,
    "name": "Seagulls, stop it now",
    "description": null,
    "membership": "open",
    "can_invite": "members",
    "can_bulletin_board_posts": "members",
    "can_add_discussions": "members",
    "can_upload_files": "members",
    "enable_chat": true,
    "public": true,
    "official": false,
    "image_file_id": null,
    "status": "active",
    "status_by_id": null,
    "status_at": null,
    "added_at": "2019-01-22T23:50:55+00:00",
    "added_by_id": 11,
    "sandbox": true
}

Retrieves a specific Group object.

HTTP Request

GET /groups/(group)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

members
roles