Jump to >

Review Group User List Resource

Name users
URI /api/groups/{group_name}/users/
Description Provides information on users that are members of a review group.
HTTP Methods
  • GET - Retrieves the list of users belonging to a specific review group.
  • POST - Adds a user to a review group.
Parent Resource Review Group Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Retrieves the list of users belonging to a specific review group.

This includes only the users who have active accounts on the site. Any account that has been disabled (for inactivity, spam reasons, or anything else) will be excluded from the list.

The list of users can be filtered down using the q and fullname parameters.

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

If fullname is set to 1, the first and last names will also be checked along with the username. fullname is ignored if q is not set.

For example, accessing /api/users/?q=bo&fullname=1 will list any users with a username, first name or last name starting with bo.

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.
max-results (optional) Integer The maximum number of results to return in this list. By default, this is 25.
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

Adds a user to a review group.

Request Parameters

Field Type Description
username (required) String The user to add to the group.

Errors

Examples

application/vnd.reviewboard.org.users+json

{
  "links": {
    "create": {
      "href": "http://reviews.example.com/api/groups/devgroup/users/", 
      "method": "POST"
    }, 
    "self": {
      "href": "http://reviews.example.com/api/groups/devgroup/users/", 
      "method": "GET"
    }
  }, 
  "stat": "ok", 
  "total_results": 2, 
  "users": [
    {
      "avatar_url": "http://www.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e", 
      "email": "doc@example.com", 
      "first_name": "Doc", 
      "fullname": "Doc Dwarf", 
      "id": 2, 
      "last_name": "Dwarf", 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/users/doc/", 
          "method": "GET"
        }, 
        "watched": {
          "href": "http://reviews.example.com/api/users/doc/watched/", 
          "method": "GET"
        }
      }, 
      "url": "/users/doc/", 
      "username": "doc"
    }, 
    {
      "avatar_url": "http://www.gravatar.com/avatar/1a0098e6600792ea4f714aa205bf3f2b", 
      "email": "dopey@example.com", 
      "first_name": "Dopey", 
      "fullname": "Dopey Dwarf", 
      "id": 3, 
      "last_name": "Dwarf", 
      "links": {
        "self": {
          "href": "http://reviews.example.com/api/users/dopey/", 
          "method": "GET"
        }, 
        "watched": {
          "href": "http://reviews.example.com/api/users/dopey/watched/", 
          "method": "GET"
        }
      }, 
      "url": "/users/dopey/", 
      "username": "dopey"
    }
  ]
}

application/vnd.reviewboard.org.users+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <total_results>2</total_results>
 <stat>ok</stat>
 <users>
  <array>
   <item>
    <username>doc</username>
    <first_name>Doc</first_name>
    <last_name>Dwarf</last_name>
    <links>
     <watched>
      <href>http://reviews.example.com/api/users/doc/watched/</href>
      <method>GET</method>
     </watched>
     <self>
      <href>http://reviews.example.com/api/users/doc/</href>
      <method>GET</method>
     </self>
    </links>
    <url>/users/doc/</url>
    <email>doc@example.com</email>
    <avatar_url>http://www.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e</avatar_url>
    <fullname>Doc Dwarf</fullname>
    <id>2</id>
   </item>
   <item>
    <username>dopey</username>
    <first_name>Dopey</first_name>
    <last_name>Dwarf</last_name>
    <links>
     <watched>
      <href>http://reviews.example.com/api/users/dopey/watched/</href>
      <method>GET</method>
     </watched>
     <self>
      <href>http://reviews.example.com/api/users/dopey/</href>
      <method>GET</method>
     </self>
    </links>
    <url>/users/dopey/</url>
    <email>dopey@example.com</email>
    <avatar_url>http://www.gravatar.com/avatar/1a0098e6600792ea4f714aa205bf3f2b</avatar_url>
    <fullname>Dopey Dwarf</fullname>
    <id>3</id>
   </item>
  </array>
 </users>
 <links>
  <self>
   <href>http://reviews.example.com/api/groups/devgroup/users/</href>
   <method>GET</method>
  </self>
  <create>
   <href>http://reviews.example.com/api/groups/devgroup/users/</href>
   <method>POST</method>
  </create>
 </links>
</rsp>