• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Board 1.5
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Web API Guide
    14. REST API 2.0
    15. Resources
    16. Root List Resource
    17. Review Request List Resource
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • General Workflow
  • Navigating Review Board
  • Dashboard
  • Searching
  • Managing Review Requests
  • Creating Review Requests
  • Updating Review Requests
  • Closing Review Requests
  • Reviewing Review Requests
  • Reviewing Diffs
  • Reviewing Screenshots
  • Editing and Publishing Reviews
  • Replying to Comments
  • Tools
  • post-review
  • Administration Guide
  • Installation
  • Installing on Linux
  • Installing on Windows
  • Upgrading Review Board
  • Installing Development Releases
  • Site Maintenance
  • The rb-site Tool
  • Creating Sites
  • Upgrading Sites
  • Enabling Search
  • Management Commands
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Settings
  • General Settings
  • Authentication Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • File Storage Settings
  • Management
  • Managing Default Reviewers
  • Managing Permission Groups
  • Managing Repositories
  • Managing Review Groups
  • Managing Users
  • Web API Guide
  • Overview
  • Authenticating
  • Resource Tree
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • REST API 2.0
  • Overview
  • Authenticating
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • REST API 1.0 (deprecated)
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Frequently Asked Questions
  • General Index
  • Release Notes
  • This documentation covers Review Board 1.5. You can select a version above or view the latest documentation.

    Review Request List ResourceΒΆ

    Name review_requests
    URI /api/review-requests/
    Description Provides information on review requests.
    HTTP Methods
    • GET - Returns all review requests that the user has read access to.
    • POST - Creates a new review request.
    Parent Resource Root List Resource
    Child Resources
    • Review Request Resource
    Anonymous Access Yes, if anonymous site access is enabled

    LinksΒΆ

    Name Method Resource
    create POST Review Request List Resource
    self GET Review Request List Resource

    HTTP GETΒΆ

    Returns all review requests that the user has read access to.

    By default, this returns all published or formerly published review requests.

    The resulting list can be filtered down through the many request parameters.

    Request ParametersΒΆ

    Field Type Description
    changenum (optional) String The change number the review requests must have set. This will only return one review request per repository, and only works for repository types that support server-side changesets.
    counts-only (optional) Boolean If specified, a single count field is returned with the number of results, instead of the results themselves.
    from-user (optional) String The username that the review requests must be owned by.
    last-updated-from (optional) String The earliest date/time the review request could be last updated. This is compared against the review request’s last_updated field. This must be a valid date/time format.
    last-updated-to (optional) String The date/time that all review requests must be last updated before. This is compared against the review request’s last_updated field. This must be a valid date/time format.
    max-results (optional) Integer The maximum number of results to return in this list. By default, this is 25.
    repository (optional) Integer The ID of the repository that the review requests must be on.
    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.
    status (optional) One of all, discarded, pending, submitted The status of the review requests.
    time-added-from (optional) String The earliest date/time the review request could be added. This is compared against the review request’s time_added field. This must be a valid date/time format.
    time-added-to (optional) String The date/time that all review requests must be added before. This is compared against the review request’s time_added field. This must be a valid date/time format.
    to-groups (optional) String A comma-separated list of review group names that the review requests must have in the reviewer list.
    to-user-groups (optional) String A comma-separated list of usernames who are in groups that the review requests must have in the reviewer list.
    to-users (optional) String A comma-separated list of usernames that the review requests must either have in the reviewer list specifically or by way of a group.
    to-users-directly (optional) String A comma-separated list of usernames that the review requests must have in the reviewer list specifically.

    HTTP POSTΒΆ

    Creates a new review request.

    The new review request will start off as private and pending, and will normally be blank. However, if changenum is passed and the given repository both supports server-side changesets and has changeset support in Review Board, some details (Summary, Description and Testing Done sections, for instance) may be automatically filled in from the server.

    Any new review request will have an associated draft (reachable through the draft link). All the details of the review request must be set through the draft. The new review request will be public when that first draft is published.

    The only requirement when creating a review request is that a valid repository is passed. This can be a numeric repository ID, the name of a repository, or the path to a repository (matching exactly the registered repository’s Path or Mirror Path fields in the adminstration interface). Failing to pass a valid repository will result in an error.

    Clients can create review requests on behalf of another user by setting the submit_as parameter to the username of the desired user. This requires that the client is currently logged in as a user that has the reviews.can_submit_as_another_user permission set. This capability is useful when writing automation scripts, such as post-commit hooks, that need to create review requests for another user.

    Request ParametersΒΆ

    Field Type Description
    changenum (optional) Integer The optional changenumber to look up for the review request details. This only works with repositories that support server-side changesets.
    repository (required) String The path or ID of the repository that the review request is for.
    submit_as (optional) String The optional user to submit the review request as. This requires that the actual logged in user is either a superuser or has the “reviews.can_submit_as_another_user” permission.

    ErrorsΒΆ

    • 101 - Permission Denied
    • 103 - Not Logged In
    • 203 - Invalid Change Number
    • 204 - Change Number In Use
    • 206 - Invalid Repository
    • 208 - Invalid User
    • 212 - Empty Changeset

    ExamplesΒΆ

    application/jsonΒΆ

    {
      "links": {
        "create": {
          "href": "http://reviews.example.com/api/review-requests/", 
          "method": "POST"
        }, 
        "self": {
          "href": "http://reviews.example.com/api/review-requests/", 
          "method": "GET"
        }
      }, 
      "review_requests": [
        {
          "branch": "trunk", 
          "bugs_closed": [], 
          "changenum": null, 
          "description": "This is a test designed for interdiffs.", 
          "id": 8, 
          "last_updated": "2010-08-28 02:26:18", 
          "links": {
            "delete": {
              "href": "http://reviews.example.com/api/review-requests/8/", 
              "method": "DELETE"
            }, 
            "diffs": {
              "href": "http://reviews.example.com/api/review-requests/8/diffs/", 
              "method": "GET"
            }, 
            "draft": {
              "href": "http://reviews.example.com/api/review-requests/8/draft/", 
              "method": "GET"
            }, 
            "last_update": {
              "href": "http://reviews.example.com/api/review-requests/8/last-update/", 
              "method": "GET"
            }, 
            "repository": {
              "href": "http://reviews.example.com/api/repositories/1/", 
              "method": "GET", 
              "title": "Review Board SVN"
            }, 
            "reviews": {
              "href": "http://reviews.example.com/api/review-requests/8/reviews/", 
              "method": "GET"
            }, 
            "screenshots": {
              "href": "http://reviews.example.com/api/review-requests/8/screenshots/", 
              "method": "GET"
            }, 
            "self": {
              "href": "http://reviews.example.com/api/review-requests/8/", 
              "method": "GET"
            }, 
            "submitter": {
              "href": "http://reviews.example.com/api/users/admin/", 
              "method": "GET", 
              "title": "admin"
            }, 
            "update": {
              "href": "http://reviews.example.com/api/review-requests/8/", 
              "method": "PUT"
            }
          }, 
          "public": true, 
          "status": "pending", 
          "summary": "Interdiff Revision Test", 
          "target_groups": [], 
          "target_people": [
            {
              "href": "http://reviews.example.com/api/users/grumpy/", 
              "method": "GET", 
              "title": "grumpy"
            }
          ], 
          "testing_done": "", 
          "time_added": "2009-02-25 02:01:21"
        }, 
        {
          "branch": "", 
          "bugs_closed": [
            "12345"
          ], 
          "changenum": 1234, 
          "description": "Test description.", 
          "id": 4, 
          "last_updated": "2007-06-24 01:11:24", 
          "links": {
            "delete": {
              "href": "http://reviews.example.com/api/review-requests/4/", 
              "method": "DELETE"
            }, 
            "diffs": {
              "href": "http://reviews.example.com/api/review-requests/4/diffs/", 
              "method": "GET"
            }, 
            "draft": {
              "href": "http://reviews.example.com/api/review-requests/4/draft/", 
              "method": "GET"
            }, 
            "last_update": {
              "href": "http://reviews.example.com/api/review-requests/4/last-update/", 
              "method": "GET"
            }, 
            "repository": {
              "href": "http://reviews.example.com/api/repositories/1/", 
              "method": "GET", 
              "title": "Review Board SVN"
            }, 
            "reviews": {
              "href": "http://reviews.example.com/api/review-requests/4/reviews/", 
              "method": "GET"
            }, 
            "screenshots": {
              "href": "http://reviews.example.com/api/review-requests/4/screenshots/", 
              "method": "GET"
            }, 
            "self": {
              "href": "http://reviews.example.com/api/review-requests/4/", 
              "method": "GET"
            }, 
            "submitter": {
              "href": "http://reviews.example.com/api/users/grumpy/", 
              "method": "GET", 
              "title": "grumpy"
            }, 
            "update": {
              "href": "http://reviews.example.com/api/review-requests/4/", 
              "method": "PUT"
            }
          }, 
          "public": true, 
          "status": "pending", 
          "summary": "Made e-mail improvements", 
          "target_groups": [], 
          "target_people": [
            {
              "href": "http://reviews.example.com/api/users/doc/", 
              "method": "GET", 
              "title": "doc"
            }
          ], 
          "testing_done": "Tested.", 
          "time_added": "2007-06-24 00:42:42"
        }, 
        {
          "branch": "trunk", 
          "bugs_closed": [], 
          "changenum": null, 
          "description": "Foo", 
          "id": 6, 
          "last_updated": "2007-06-24 01:10:59", 
          "links": {
            "delete": {
              "href": "http://reviews.example.com/api/review-requests/6/", 
              "method": "DELETE"
            }, 
            "diffs": {
              "href": "http://reviews.example.com/api/review-requests/6/diffs/", 
              "method": "GET"
            }, 
            "draft": {
              "href": "http://reviews.example.com/api/review-requests/6/draft/", 
              "method": "GET"
            }, 
            "last_update": {
              "href": "http://reviews.example.com/api/review-requests/6/last-update/", 
              "method": "GET"
            }, 
            "repository": {
              "href": "http://reviews.example.com/api/repositories/1/", 
              "method": "GET", 
              "title": "Review Board SVN"
            }, 
            "reviews": {
              "href": "http://reviews.example.com/api/review-requests/6/reviews/", 
              "method": "GET"
            }, 
            "screenshots": {
              "href": "http://reviews.example.com/api/review-requests/6/screenshots/", 
              "method": "GET"
            }, 
            "self": {
              "href": "http://reviews.example.com/api/review-requests/6/", 
              "method": "GET"
            }, 
            "submitter": {
              "href": "http://reviews.example.com/api/users/dopey/", 
              "method": "GET", 
              "title": "dopey"
            }, 
            "update": {
              "href": "http://reviews.example.com/api/review-requests/6/", 
              "method": "PUT"
            }
          }, 
          "public": true, 
          "status": "pending", 
          "summary": "Error dialog", 
          "target_groups": [
            {
              "href": "http://reviews.example.com/api/groups/emptygroup/", 
              "method": "GET", 
              "title": "emptygroup"
            }
          ], 
          "target_people": [], 
          "testing_done": "Bar", 
          "time_added": "2007-06-24 00:47:14"
        }, 
        {
          "branch": "trunk", 
          "bugs_closed": [
            "123"
          ], 
          "changenum": null, 
          "description": "Be compatible with cleaned_data changes in Django.", 
          "id": 2, 
          "last_updated": "2007-06-24 00:34:17", 
          "links": {
            "delete": {
              "href": "http://reviews.example.com/api/review-requests/2/", 
              "method": "DELETE"
            }, 
            "diffs": {
              "href": "http://reviews.example.com/api/review-requests/2/diffs/", 
              "method": "GET"
            }, 
            "draft": {
              "href": "http://reviews.example.com/api/review-requests/2/draft/", 
              "method": "GET"
            }, 
            "last_update": {
              "href": "http://reviews.example.com/api/review-requests/2/last-update/", 
              "method": "GET"
            }, 
            "repository": {
              "href": "http://reviews.example.com/api/repositories/1/", 
              "method": "GET", 
              "title": "Review Board SVN"
            }, 
            "reviews": {
              "href": "http://reviews.example.com/api/review-requests/2/reviews/", 
              "method": "GET"
            }, 
            "screenshots": {
              "href": "http://reviews.example.com/api/review-requests/2/screenshots/", 
              "method": "GET"
            }, 
            "self": {
              "href": "http://reviews.example.com/api/review-requests/2/", 
              "method": "GET"
            }, 
            "submitter": {
              "href": "http://reviews.example.com/api/users/dopey/", 
              "method": "GET", 
              "title": "dopey"
            }, 
            "update": {
              "href": "http://reviews.example.com/api/review-requests/2/", 
              "method": "PUT"
            }
          }, 
          "public": true, 
          "status": "pending", 
          "summary": "Update for cleaned_data changes", 
          "target_groups": [
            {
              "href": "http://reviews.example.com/api/groups/devgroup/", 
              "method": "GET", 
              "title": "devgroup"
            }
          ], 
          "target_people": [], 
          "testing_done": "Works.", 
          "time_added": "2007-06-24 00:14:32"
        }, 
        {
          "branch": "trunk", 
          "bugs_closed": [
            "1234", 
            "4321", 
            "5678", 
            "8765"
          ], 
          "changenum": null, 
          "description": "Added some user permissions checking for JSON API functions.", 
          "id": 3, 
          "last_updated": "2007-06-24 00:28:33", 
          "links": {
            "delete": {
              "href": "http://reviews.example.com/api/review-requests/3/", 
              "method": "DELETE"
            }, 
            "diffs": {
              "href": "http://reviews.example.com/api/review-requests/3/diffs/", 
              "method": "GET"
            }, 
            "draft": {
              "href": "http://reviews.example.com/api/review-requests/3/draft/", 
              "method": "GET"
            }, 
            "last_update": {
              "href": "http://reviews.example.com/api/review-requests/3/last-update/", 
              "method": "GET"
            }, 
            "repository": {
              "href": "http://reviews.example.com/api/repositories/1/", 
              "method": "GET", 
              "title": "Review Board SVN"
            }, 
            "reviews": {
              "href": "http://reviews.example.com/api/review-requests/3/reviews/", 
              "method": "GET"
            }, 
            "screenshots": {
              "href": "http://reviews.example.com/api/review-requests/3/screenshots/", 
              "method": "GET"
            }, 
            "self": {
              "href": "http://reviews.example.com/api/review-requests/3/", 
              "method": "GET"
            }, 
            "submitter": {
              "href": "http://reviews.example.com/api/users/admin/", 
              "method": "GET", 
              "title": "admin"
            }, 
            "update": {
              "href": "http://reviews.example.com/api/review-requests/3/", 
              "method": "PUT"
            }
          }, 
          "public": true, 
          "status": "pending", 
          "summary": "Add permission checking for JSON API", 
          "target_groups": [
            {
              "href": "http://reviews.example.com/api/groups/privgroup/", 
              "method": "GET", 
              "title": "privgroup"
            }
          ], 
          "target_people": [
            {
              "href": "http://reviews.example.com/api/users/doc/", 
              "method": "GET", 
              "title": "doc"
            }, 
            {
              "href": "http://reviews.example.com/api/users/dopey/", 
              "method": "GET", 
              "title": "dopey"
            }
          ], 
          "testing_done": "Tested some functions.", 
          "time_added": "2007-06-24 00:17:33"
        }
      ], 
      "stat": "ok", 
      "total_results": 5
    }
    

    application/xmlΒΆ

    <?xml version="1.0" encoding="utf-8"?>
    <rsp>
     <total_results>5</total_results>
     <stat>ok</stat>
     <review_requests>
      <array>
       <item>
        <status>pending</status>
        <last_updated>2010-08-28 02:26:18</last_updated>
        <description>This is a test designed for interdiffs.</description>
        <links>
         <diffs>
          <href>http://reviews.example.com/api/review-requests/8/diffs/</href>
          <method>GET</method>
         </diffs>
         <repository>
          <href>http://reviews.example.com/api/repositories/1/</href>
          <method>GET</method>
          <title>Review Board SVN</title>
         </repository>
         <self>
          <href>http://reviews.example.com/api/review-requests/8/</href>
          <method>GET</method>
         </self>
         <update>
          <href>http://reviews.example.com/api/review-requests/8/</href>
          <method>PUT</method>
         </update>
         <last_update>
          <href>http://reviews.example.com/api/review-requests/8/last-update/</href>
          <method>GET</method>
         </last_update>
         <reviews>
          <href>http://reviews.example.com/api/review-requests/8/reviews/</href>
          <method>GET</method>
         </reviews>
         <draft>
          <href>http://reviews.example.com/api/review-requests/8/draft/</href>
          <method>GET</method>
         </draft>
         <submitter>
          <href>http://reviews.example.com/api/users/admin/</href>
          <method>GET</method>
          <title>admin</title>
         </submitter>
         <screenshots>
          <href>http://reviews.example.com/api/review-requests/8/screenshots/</href>
          <method>GET</method>
         </screenshots>
         <delete>
          <href>http://reviews.example.com/api/review-requests/8/</href>
          <method>DELETE</method>
         </delete>
        </links>
        <public>1</public>
        <target_groups>
         <array>
         </array>
        </target_groups>
        <bugs_closed>
         <array>
         </array>
        </bugs_closed>
        <changenum>
        </changenum>
        <target_people>
         <array>
          <item>
           <href>http://reviews.example.com/api/users/grumpy/</href>
           <method>GET</method>
           <title>grumpy</title>
          </item>
         </array>
        </target_people>
        <testing_done></testing_done>
        <branch>trunk</branch>
        <time_added>2009-02-25 02:01:21</time_added>
        <summary>Interdiff Revision Test</summary>
        <id>8</id>
       </item>
       <item>
        <status>pending</status>
        <last_updated>2007-06-24 01:11:24</last_updated>
        <description>Test description.</description>
        <links>
         <diffs>
          <href>http://reviews.example.com/api/review-requests/4/diffs/</href>
          <method>GET</method>
         </diffs>
         <repository>
          <href>http://reviews.example.com/api/repositories/1/</href>
          <method>GET</method>
          <title>Review Board SVN</title>
         </repository>
         <self>
          <href>http://reviews.example.com/api/review-requests/4/</href>
          <method>GET</method>
         </self>
         <update>
          <href>http://reviews.example.com/api/review-requests/4/</href>
          <method>PUT</method>
         </update>
         <last_update>
          <href>http://reviews.example.com/api/review-requests/4/last-update/</href>
          <method>GET</method>
         </last_update>
         <reviews>
          <href>http://reviews.example.com/api/review-requests/4/reviews/</href>
          <method>GET</method>
         </reviews>
         <draft>
          <href>http://reviews.example.com/api/review-requests/4/draft/</href>
          <method>GET</method>
         </draft>
         <submitter>
          <href>http://reviews.example.com/api/users/grumpy/</href>
          <method>GET</method>
          <title>grumpy</title>
         </submitter>
         <screenshots>
          <href>http://reviews.example.com/api/review-requests/4/screenshots/</href>
          <method>GET</method>
         </screenshots>
         <delete>
          <href>http://reviews.example.com/api/review-requests/4/</href>
          <method>DELETE</method>
         </delete>
        </links>
        <public>1</public>
        <target_groups>
         <array>
         </array>
        </target_groups>
        <bugs_closed>
         <array>
          <item>12345</item>
         </array>
        </bugs_closed>
        <changenum>1234</changenum>
        <target_people>
         <array>
          <item>
           <href>http://reviews.example.com/api/users/doc/</href>
           <method>GET</method>
           <title>doc</title>
          </item>
         </array>
        </target_people>
        <testing_done>Tested.</testing_done>
        <branch></branch>
        <time_added>2007-06-24 00:42:42</time_added>
        <summary>Made e-mail improvements</summary>
        <id>4</id>
       </item>
       <item>
        <status>pending</status>
        <last_updated>2007-06-24 01:10:59</last_updated>
        <description>Foo</description>
        <links>
         <diffs>
          <href>http://reviews.example.com/api/review-requests/6/diffs/</href>
          <method>GET</method>
         </diffs>
         <repository>
          <href>http://reviews.example.com/api/repositories/1/</href>
          <method>GET</method>
          <title>Review Board SVN</title>
         </repository>
         <self>
          <href>http://reviews.example.com/api/review-requests/6/</href>
          <method>GET</method>
         </self>
         <update>
          <href>http://reviews.example.com/api/review-requests/6/</href>
          <method>PUT</method>
         </update>
         <last_update>
          <href>http://reviews.example.com/api/review-requests/6/last-update/</href>
          <method>GET</method>
         </last_update>
         <reviews>
          <href>http://reviews.example.com/api/review-requests/6/reviews/</href>
          <method>GET</method>
         </reviews>
         <draft>
          <href>http://reviews.example.com/api/review-requests/6/draft/</href>
          <method>GET</method>
         </draft>
         <submitter>
          <href>http://reviews.example.com/api/users/dopey/</href>
          <method>GET</method>
          <title>dopey</title>
         </submitter>
         <screenshots>
          <href>http://reviews.example.com/api/review-requests/6/screenshots/</href>
          <method>GET</method>
         </screenshots>
         <delete>
          <href>http://reviews.example.com/api/review-requests/6/</href>
          <method>DELETE</method>
         </delete>
        </links>
        <public>1</public>
        <target_groups>
         <array>
          <item>
           <href>http://reviews.example.com/api/groups/emptygroup/</href>
           <method>GET</method>
           <title>emptygroup</title>
          </item>
         </array>
        </target_groups>
        <bugs_closed>
         <array>
         </array>
        </bugs_closed>
        <changenum>
        </changenum>
        <target_people>
         <array>
         </array>
        </target_people>
        <testing_done>Bar</testing_done>
        <branch>trunk</branch>
        <time_added>2007-06-24 00:47:14</time_added>
        <summary>Error dialog</summary>
        <id>6</id>
       </item>
       <item>
        <status>pending</status>
        <last_updated>2007-06-24 00:34:17</last_updated>
        <description>Be compatible with cleaned_data changes in Django.</description>
        <links>
         <diffs>
          <href>http://reviews.example.com/api/review-requests/2/diffs/</href>
          <method>GET</method>
         </diffs>
         <repository>
          <href>http://reviews.example.com/api/repositories/1/</href>
          <method>GET</method>
          <title>Review Board SVN</title>
         </repository>
         <self>
          <href>http://reviews.example.com/api/review-requests/2/</href>
          <method>GET</method>
         </self>
         <update>
          <href>http://reviews.example.com/api/review-requests/2/</href>
          <method>PUT</method>
         </update>
         <last_update>
          <href>http://reviews.example.com/api/review-requests/2/last-update/</href>
          <method>GET</method>
         </last_update>
         <reviews>
          <href>http://reviews.example.com/api/review-requests/2/reviews/</href>
          <method>GET</method>
         </reviews>
         <draft>
          <href>http://reviews.example.com/api/review-requests/2/draft/</href>
          <method>GET</method>
         </draft>
         <submitter>
          <href>http://reviews.example.com/api/users/dopey/</href>
          <method>GET</method>
          <title>dopey</title>
         </submitter>
         <screenshots>
          <href>http://reviews.example.com/api/review-requests/2/screenshots/</href>
          <method>GET</method>
         </screenshots>
         <delete>
          <href>http://reviews.example.com/api/review-requests/2/</href>
          <method>DELETE</method>
         </delete>
        </links>
        <public>1</public>
        <target_groups>
         <array>
          <item>
           <href>http://reviews.example.com/api/groups/devgroup/</href>
           <method>GET</method>
           <title>devgroup</title>
          </item>
         </array>
        </target_groups>
        <bugs_closed>
         <array>
          <item>123</item>
         </array>
        </bugs_closed>
        <changenum>
        </changenum>
        <target_people>
         <array>
         </array>
        </target_people>
        <testing_done>Works.</testing_done>
        <branch>trunk</branch>
        <time_added>2007-06-24 00:14:32</time_added>
        <summary>Update for cleaned_data changes</summary>
        <id>2</id>
       </item>
       <item>
        <status>pending</status>
        <last_updated>2007-06-24 00:28:33</last_updated>
        <description>Added some user permissions checking for JSON API functions.</description>
        <links>
         <diffs>
          <href>http://reviews.example.com/api/review-requests/3/diffs/</href>
          <method>GET</method>
         </diffs>
         <repository>
          <href>http://reviews.example.com/api/repositories/1/</href>
          <method>GET</method>
          <title>Review Board SVN</title>
         </repository>
         <self>
          <href>http://reviews.example.com/api/review-requests/3/</href>
          <method>GET</method>
         </self>
         <update>
          <href>http://reviews.example.com/api/review-requests/3/</href>
          <method>PUT</method>
         </update>
         <last_update>
          <href>http://reviews.example.com/api/review-requests/3/last-update/</href>
          <method>GET</method>
         </last_update>
         <reviews>
          <href>http://reviews.example.com/api/review-requests/3/reviews/</href>
          <method>GET</method>
         </reviews>
         <draft>
          <href>http://reviews.example.com/api/review-requests/3/draft/</href>
          <method>GET</method>
         </draft>
         <submitter>
          <href>http://reviews.example.com/api/users/admin/</href>
          <method>GET</method>
          <title>admin</title>
         </submitter>
         <screenshots>
          <href>http://reviews.example.com/api/review-requests/3/screenshots/</href>
          <method>GET</method>
         </screenshots>
         <delete>
          <href>http://reviews.example.com/api/review-requests/3/</href>
          <method>DELETE</method>
         </delete>
        </links>
        <public>1</public>
        <target_groups>
         <array>
          <item>
           <href>http://reviews.example.com/api/groups/privgroup/</href>
           <method>GET</method>
           <title>privgroup</title>
          </item>
         </array>
        </target_groups>
        <bugs_closed>
         <array>
          <item>1234</item>
          <item>4321</item>
          <item>5678</item>
          <item>8765</item>
         </array>
        </bugs_closed>
        <changenum>
        </changenum>
        <target_people>
         <array>
          <item>
           <href>http://reviews.example.com/api/users/doc/</href>
           <method>GET</method>
           <title>doc</title>
          </item>
          <item>
           <href>http://reviews.example.com/api/users/dopey/</href>
           <method>GET</method>
           <title>dopey</title>
          </item>
         </array>
        </target_people>
        <testing_done>Tested some functions.</testing_done>
        <branch>trunk</branch>
        <time_added>2007-06-24 00:17:33</time_added>
        <summary>Add permission checking for JSON API</summary>
        <id>3</id>
       </item>
      </array>
     </review_requests>
     <links>
      <self>
       <href>http://reviews.example.com/api/review-requests/</href>
       <method>GET</method>
      </self>
      <create>
       <href>http://reviews.example.com/api/review-requests/</href>
       <method>POST</method>
      </create>
     </links>
    </rsp>
    

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Links
    • HTTP GET
      • Request Parameters
    • HTTP POST
      • Request Parameters
      • Errors
    • Examples
      • application/json
      • application/xml