Jump to >

User Resource

Creates and provides information on users.

If a user’s profile is private, the fields email, first_name, last_name, and fullname will be omitted for non-staff users.


Name user
URI /api/users/{username}/
Token Policy ID user
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



The URL for an avatar representing the user.

Added in 1.6.14

emailString The user’s e-mail address
first_nameString The user’s first name.
fullnameString The user’s full name (first and last).
idInteger The numeric ID of the user.

Whether or not the user is active. Inactive usersare not able to log in or make changes to Review Board.

Added in 2.5.9

last_nameString The user’s last name.
urlString The URL to the user’s page on the site. This is deprecated and will be removed in a future version.
usernameString The user’s username.


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”.


100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in



$ curl http://reviews.example.com/api/users/admin/ -H "Accept: application/json"
Vary: Accept, Cookie
ETag: b03dd0aeb4900de2c2ef8356daaea7350cdf5538
Content-Type: application/vnd.reviewboard.org.user+json
X-Content-Type-Options: nosniff
  "stat": "ok", 
  "user": {
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?d=mm", 
    "email": "admin@example.com", 
    "first_name": "Admin", 
    "fullname": "Admin User", 
    "id": 1, 
    "is_active": true, 
    "last_name": "User", 
    "links": {
      "api_tokens": {
        "href": "http://reviews.example.com/api/users/admin/api-tokens/", 
        "method": "GET"
      "archived_review_requests": {
        "href": "http://reviews.example.com/api/users/admin/archived-review-requests/", 
        "method": "GET"
      "muted_review_requests": {
        "href": "http://reviews.example.com/api/users/admin/muted-review-requests/", 
        "method": "GET"
      "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"