Jump to >

Review Group User Resource

Name user
URI /api/groups/{group_name}/users/{username}/
Description Provides information on users that are members of a review group.
HTTP Methods
  • DELETE - Removes a user from a review group.
  • GET - Retrieve information on a registered user.
Parent Resource Review Group User List Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

Fields

Field Type Description
avatar_url String The URL for an avatar representing the user.
email String The user’s e-mail address
first_name String The user’s first name.
fullname String The user’s full name (first and last).
id Integer The numeric ID of the user.
last_name String The user’s last name.
url String The URL to the user’s page on the site. This is deprecated and will be removed in a future version.
username String The user’s username.

HTTP DELETE

Removes a user from a review group.

HTTP GET

Retrieve information on a registered user.

This mainly returns some basic information (username, full name, e-mail address) and links to that user’s root Watched Items resource, which is used for keeping track of the groups and review requests that the user has “starred”.

Examples

application/vnd.reviewboard.org.user+json

{
  "stat": "ok", 
  "user": {
    "avatar_url": "http://www.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e", 
    "email": "doc@example.com", 
    "first_name": "Doc", 
    "fullname": "Doc Dwarf", 
    "id": 2, 
    "last_name": "Dwarf", 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/users/doc/", 
        "method": "DELETE"
      }, 
      "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"
  }
}

application/vnd.reviewboard.org.user+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <user>
  <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>
   <delete>
    <href>http://reviews.example.com/api/users/doc/</href>
    <method>DELETE</method>
   </delete>
  </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>
 </user>
</rsp>