Root Review List Resource¶

Added in 5.0

Provides information on reviews.

This is a top level endpoint that allows you to list and query all reviews in the system.

Version Changed:: 5.0.4: This was formally named reviews on the root resource, but had to be renamed to all_reviews in order to work around a conflict with URI templates.
Version Added:: 5.0

Details¶

Name	`reviews`
URI	`/api/reviews/`
Token Policy ID	`review`
HTTP Methods	GET - Return the list of reviews.
Parent Resource	Root List Resource
Child Resources	None

Links¶

Name	Method	Resource
self	GET	Root Review List Resource

HTTP GET¶

Return the list of reviews.

Request Parameters¶

counts-onlyBoolean	If specified, a single `count` field is returned with the number of results, instead of the results themselves.
last-updated-from ISO 8601 Date/Time	The earliest date/time the review could be last updated. This is compared against the review’s `timestamp` field. This must be a valid date/time format.
last-updated-to ISO 8601 Date/Time	The date/time that the reviews must be last updated before. This is compared against the review’s `timestamp` field. This must be a valid date/time format.
max-resultsInteger	The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link.
publicBoolean	Whether to filter for public (published) reviews. If not set, both published and unpublished reviews will be included.
repositoryString	The repository name that the review requests of the reviews must be part of.
review-groupString	The group name of users that the reviews must be owned by.
startInteger	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.
userString	The username of the user that the reviews must be owned by.

Errors¶

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
105 - Invalid Form DataHTTP 400 - Bad Request	One or more fields had errors
112 - OAuth2 Missing Scope ErrorHTTP 403 - Forbidden	Your OAuth2 token lacks the necessary scopes for this request.
113 - OAuth2 Access Denied ErrorHTTP 403 - Forbidden	OAuth2 token access for this resource is prohibited.

Examples¶

application/vnd.reviewboard.org.reviews+json¶

$ curl https://reviews.example.com/api/reviews/ -H "Accept: application/json"

HTTP 200 OK
Content-Length: 8183
Content-Type: application/vnd.reviewboard.org.reviews+json
ETag: c50547250d7b3007829bb5c8abd2346c87ea7782
Item-Content-Type: application/vnd.reviewboard.org.review+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "links": {
    "self": {
      "href": "https://reviews.example.com/api/reviews/",
      "method": "GET"
    }
  },
  "reviews": [
    {
      "absolute_url": "https://reviews.example.com/r/2/#review1",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "Looks fine.",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 1,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/2/reviews/1/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/doc/",
          "method": "GET",
          "title": "doc"
        }
      },
      "public": true,
      "ship_it": true,
      "text_type": null,
      "timestamp": "2007-06-24T00:16:41Z"
    },
    {
      "absolute_url": "https://reviews.example.com/r/3/#review2",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "Test",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 2,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/2/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/doc/",
          "method": "GET",
          "title": "doc"
        }
      },
      "public": true,
      "ship_it": false,
      "text_type": null,
      "timestamp": "2007-06-24T00:21:45Z"
    },
    {
      "absolute_url": "https://reviews.example.com/r/3/#review4",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 4,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/4/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/dopey/",
          "method": "GET",
          "title": "dopey"
        }
      },
      "public": true,
      "ship_it": false,
      "text_type": null,
      "timestamp": "2007-06-24T00:23:43Z"
    },
    {
      "absolute_url": "https://reviews.example.com/r/3/#review5",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "Grumpy body",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 5,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/3/reviews/5/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/grumpy/",
          "method": "GET",
          "title": "grumpy"
        }
      },
      "public": true,
      "ship_it": false,
      "text_type": null,
      "timestamp": "2007-06-24T00:25:33Z"
    },
    {
      "absolute_url": "https://reviews.example.com/r/8/#review8",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 8,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/8/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": true,
      "ship_it": false,
      "text_type": null,
      "timestamp": "2010-08-28T02:25:31Z"
    },
    {
      "absolute_url": "https://reviews.example.com/r/8/#review12",
      "body_bottom": "",
      "body_bottom_text_type": "plain",
      "body_top": "Only a few nits...",
      "body_top_text_type": "plain",
      "extra_data": {},
      "id": 12,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/",
          "method": "DELETE"
        },
        "diff_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/diff-comments/",
          "method": "GET"
        },
        "file_attachment_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/file-attachment-comments/",
          "method": "GET"
        },
        "general_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/general-comments/",
          "method": "GET"
        },
        "replies": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/replies/",
          "method": "GET"
        },
        "screenshot_comments": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/screenshot-comments/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/review-requests/8/reviews/12/",
          "method": "PUT"
        },
        "user": {
          "href": "https://reviews.example.com/api/users/admin/",
          "method": "GET",
          "title": "admin"
        }
      },
      "public": false,
      "ship_it": false,
      "text_type": null,
      "timestamp": "2022-08-17T02:50:02Z"
    }
  ],
  "stat": "ok",
  "total_results": 6
}