Jump to >

Review Group List Resource

Name groups
URI /api/groups/
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
  • GET - Retrieves the list of review groups on the site.
  • POST - Creates a new review group.
Parent Resource Root List Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Retrieves the list of review groups on the site.

The list of review groups can be filtered down using the q and displayname parameters.

Setting q to a value will by default limit the results to group names starting with that value. This is a case-insensitive comparison.

If displayname is set to 1, the display names will also be checked along with the username. displayname is ignored if q is not set.

For example, accessing /api/groups/?q=dev&displayname=1 will list any groups with a name or display name starting with dev.

Request Parameters

Field Type Description
counts-only (optional) Boolean If specified, a single count field is returned with the number of results, instead of the results themselves.
displayname (optional) Boolean Specifies whether q should also match the beginning of the display name.
max-results (optional) Integer The maximum number of results to return in this list. By default, this is 25.
q (optional) String The string that the group name (or the display name when using displayname) must start with in order to be included in the list. This is case-insensitive.
start (optional) Integer The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0.

HTTP POST

Creates a new review group.

This will create a brand new review group with the given name and display name. The group will be public by default, unless specified otherwise.

Request Parameters

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

Errors

Examples

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

{
  "groups": [
    {
      "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
    }, 
    {
      "display_name": "", 
      "id": 5, 
      "invite_only": false, 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/groups/docs/", 
          "method": "DELETE"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/groups/docs/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/groups/docs/", 
          "method": "PUT"
        }, 
        "users": {
          "href": "http://reviews.example.com/api/groups/docs/users/", 
          "method": "GET"
        }
      }, 
      "mailing_list": "", 
      "name": "docs", 
      "url": "/groups/docs/", 
      "visible": true
    }, 
    {
      "display_name": "Empty Group", 
      "id": 3, 
      "invite_only": false, 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/groups/emptygroup/", 
          "method": "DELETE"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/groups/emptygroup/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/groups/emptygroup/", 
          "method": "PUT"
        }, 
        "users": {
          "href": "http://reviews.example.com/api/groups/emptygroup/users/", 
          "method": "GET"
        }
      }, 
      "mailing_list": "", 
      "name": "emptygroup", 
      "url": "/groups/emptygroup/", 
      "visible": true
    }, 
    {
      "display_name": "New Group", 
      "id": 2, 
      "invite_only": false, 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/groups/newgroup/", 
          "method": "DELETE"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/groups/newgroup/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/groups/newgroup/", 
          "method": "PUT"
        }, 
        "users": {
          "href": "http://reviews.example.com/api/groups/newgroup/users/", 
          "method": "GET"
        }
      }, 
      "mailing_list": "newgroup@example.com", 
      "name": "newgroup", 
      "url": "/groups/newgroup/", 
      "visible": true
    }, 
    {
      "display_name": "Private Group", 
      "id": 4, 
      "invite_only": false, 
      "links": {
        "delete": {
          "href": "http://reviews.example.com/api/groups/privgroup/", 
          "method": "DELETE"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/groups/privgroup/", 
          "method": "GET"
        }, 
        "update": {
          "href": "http://reviews.example.com/api/groups/privgroup/", 
          "method": "PUT"
        }, 
        "users": {
          "href": "http://reviews.example.com/api/groups/privgroup/users/", 
          "method": "GET"
        }
      }, 
      "mailing_list": "", 
      "name": "privgroup", 
      "url": "/groups/privgroup/", 
      "visible": true
    }
  ], 
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/groups/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/groups/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 5
}

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

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>5</total_results>
 <stat>ok</stat>
 <groups>
  <array>
   <item>
    <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>
   </item>
   <item>
    <display_name></display_name>
    <name>docs</name>
    <links>
     <users>
      <href>http://reviews.example.com/api/groups/docs/users/</href>
      <method>GET</method>
     </users>
     <self>
      <href>http://reviews.example.com/api/groups/docs/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/groups/docs/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/groups/docs/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>/groups/docs/</url>
    <visible>1</visible>
    <invite_only>0</invite_only>
    <id>5</id>
    <mailing_list></mailing_list>
   </item>
   <item>
    <display_name>Empty Group</display_name>
    <name>emptygroup</name>
    <links>
     <users>
      <href>http://reviews.example.com/api/groups/emptygroup/users/</href>
      <method>GET</method>
     </users>
     <self>
      <href>http://reviews.example.com/api/groups/emptygroup/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/groups/emptygroup/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/groups/emptygroup/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>/groups/emptygroup/</url>
    <visible>1</visible>
    <invite_only>0</invite_only>
    <id>3</id>
    <mailing_list></mailing_list>
   </item>
   <item>
    <display_name>New Group</display_name>
    <name>newgroup</name>
    <links>
     <users>
      <href>http://reviews.example.com/api/groups/newgroup/users/</href>
      <method>GET</method>
     </users>
     <self>
      <href>http://reviews.example.com/api/groups/newgroup/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/groups/newgroup/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/groups/newgroup/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>/groups/newgroup/</url>
    <visible>1</visible>
    <invite_only>0</invite_only>
    <id>2</id>
    <mailing_list>newgroup@example.com</mailing_list>
   </item>
   <item>
    <display_name>Private Group</display_name>
    <name>privgroup</name>
    <links>
     <users>
      <href>http://reviews.example.com/api/groups/privgroup/users/</href>
      <method>GET</method>
     </users>
     <self>
      <href>http://reviews.example.com/api/groups/privgroup/</href>
      <method>GET</method>
     </self>
     <update>
      <href>http://reviews.example.com/api/groups/privgroup/</href>
      <method>PUT</method>
     </update>
     <delete>
      <href>http://reviews.example.com/api/groups/privgroup/</href>
      <method>DELETE</method>
     </delete>
    </links>
    <url>/groups/privgroup/</url>
    <visible>1</visible>
    <invite_only>0</invite_only>
    <id>4</id>
    <mailing_list></mailing_list>
   </item>
  </array>
 </groups>
 <links>
  <self>
   <href>http://reviews.example.com/api/groups/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/groups/</href>
   <method>POST</method>
  </create>
 </links>
</rsp>