Jump to >

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 or modified through the API.

HTTP Methods
  • DELETE - Deletes a review group.
  • GET - Retrieve information on a review group.
  • PUT - Updates an existing review group.
Parent Resource Review Group List Resource
Child Resources
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.
invite_only Boolean Whether or not the group is invite-only. An invite-only group is only accessible by members of the 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.
visible Boolean Whether or not the group is visible to users who are not members. This does not prevent users from accessing the group if they know it, though.

HTTP DELETE

Deletes a review group.

This will disassociate the group from all review requests previously targetting the group, and permanently delete the group.

It is best to only delete empty, unused groups, and to instead change a group to not be visible if it’s on longer needed.

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.

HTTP PUT

Updates an existing review group.

All the fields of a review group can be modified, including the name, so long as it doesn’t conflict with another review group.

Request Parameters

Field Type Description
display_name (optional) String The human-readable name of the group.
invite_only (optional) Boolean Whether or not the group is invite-only.
mailing_list (optional) String The e-mail address that all posts on a review group are sent to.
name (optional) String The new name for the group.
visible (optional) Boolean Whether or not the group is visible to users who are not members.

Examples

application/vnd.reviewboard.org.review-group+json

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

application/vnd.reviewboard.org.review-group+xml

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