We can host Review Board for you! Give us a try at RBCommons.

This documentation covers the in-development release of Review Board. You can see the latest stable docs or all previous versions.

User Resource

Name user
URI /api/users/{username}/
Description

Provides information on registered users.

If a user’s profile is private, the fields email, first_name, last_name, and fullname will be omitted for non-staff users.
HTTP Methods
  • GET - Retrieve information on a registered user.
Parent Resource User List Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

Fields

Field Type Description
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 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/json

{
  "stat": "ok", 
  "user": {
    "email": "admin@example.com", 
    "first_name": "Admin", 
    "fullname": "Admin User", 
    "id": 1, 
    "last_name": "User", 
    "links": {
      "self": {
        "href": "http://reviews.example.com/api/users/admin/", 
        "method": "GET"
      }, 
      "watched": {
        "href": "http://reviews.example.com/api/users/admin/watched/", 
        "method": "GET"
      }
    }, 
    "url": "/users/admin/", 
    "username": "admin"
  }
}

application/xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <user>
  <username>admin</username>
  <first_name>Admin</first_name>
  <last_name>User</last_name>
  <links>
   <watched>
    <href>http://reviews.example.com/api/users/admin/watched/</href>
    <method>GET</method>
   </watched>
   <self>
    <href>http://reviews.example.com/api/users/admin/</href>
    <method>GET</method>
   </self>
  </links>
  <url>/users/admin/</url>
  <id>1</id>
  <fullname>Admin User</fullname>
  <email>admin@example.com</email>
 </user>
</rsp>

application/vnd.reviewboard.org.user+json

{"stat": "ok", "user": {"username": "admin", "first_name": "Admin", "last_name": "User", "links": {"watched": {"href": "http://reviews.example.com/api/users/admin/watched/", "method": "GET"}, "self": {"href": "http://reviews.example.com/api/users/admin/", "method": "GET"}}, "url": "/users/admin/", "id": 1, "fullname": "Admin User", "email": "admin@example.com"}}

application/vnd.reviewboard.org.user+xml

<?xml version="1.0" encoding="utf-8"?>
<rsp>
 <stat>ok</stat>
 <user>
  <username>admin</username>
  <first_name>Admin</first_name>
  <last_name>User</last_name>
  <links>
   <watched>
    <href>http://reviews.example.com/api/users/admin/watched/</href>
    <method>GET</method>
   </watched>
   <self>
    <href>http://reviews.example.com/api/users/admin/</href>
    <method>GET</method>
   </self>
  </links>
  <url>/users/admin/</url>
  <id>1</id>
  <fullname>Admin User</fullname>
  <email>admin@example.com</email>
 </user>
</rsp>