Review Group Resource¶

Name	`group`
URI	`/api/groups/{group_name}/`
Description	Provides information on review groups. Review groups are groups of users that can be listed as an intended reviewer on a review request. Review groups cannot be created, deleted, or modified through the API.
HTTP Methods	GET - Retrieve information on a review group.
Parent Resource	Review Group List Resource
Child Resources	Review Group User List Resource
Anonymous Access	Yes, if anonymous site access is enabled

Fields¶

Field	Type	Description
display_name	String	The human-readable name of the group, sometimes used as a short description.
id	Integer	The numeric ID of the review group.
mailing_list	String	The e-mail address that all posts on a review group are sent to.
name	String	The short name of the group, used in the reviewer list and the Dashboard.
url	String	The URL to the user’s page on the site. This is deprecated and will be removed in a future version.

Links¶

Name	Method	Resource
self	GET	Review Group Resource
users	GET	Review Group User List Resource

HTTP GET¶

Retrieve information on a review group.

Some basic information on the review group is provided, including the name, description, and mailing list (if any) that e-mails to the group are sent to.

The group links to the list of users that are members of the group.

Errors¶

Examples¶

application/json¶

{
  "group": {
    "display_name": "Dev Group", 
    "id": 1, 
    "links": {
      "self": {
        "href": "http://reviews.example.com/api/groups/devgroup/", 
        "method": "GET"
      }, 
      "users": {
        "href": "http://reviews.example.com/api/groups/devgroup/users/", 
        "method": "GET"
      }
    }, 
    "mailing_list": "devgroup@example.com", 
    "name": "devgroup", 
    "url": "/groups/devgroup/"
  }, 
  "stat": "ok"
}

application/xml¶

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <group>
  <display_name>Dev Group</display_name>
  <name>devgroup</name>
  <links>
   <self>
    <href>http://reviews.example.com/api/groups/devgroup/</href>
    <method>GET</method>
   </self>
   <users>
    <href>http://reviews.example.com/api/groups/devgroup/users/</href>
    <method>GET</method>
   </users>
  </links>
  <url>/groups/devgroup/</url>
  <id>1</id>
  <mailing_list>devgroup@example.com</mailing_list>
 </group>
</rsp>