Root List Resource¶

The root of the Review Board API resource tree.

This should be used as a starting point for any clients that need to access any resources in the API. By browsing through the resource tree instead of hard-coding paths, your client can remain compatible with any changes in the resource URI scheme.

This also contains information on the server and the capabilities of the API. This information was formerly provided only by the Server Info resource, but has been moved here as a convenience to clients.

URI Templates

The following URI templates (found in the uri_templates key) can be used to help quickly reach the right API resource.

Note

This list may have changed between versions of Review Board, with some items added and some pointing to corrected URLs. In particular, due to a bug on some Python versions, there were differences in Review Board 4.0.x and 5.0/5.0.1.

Please check the specific URI templates for your version of Review Board if you are having any trouble.

URI template key	Resource	Version Added
`all_diff_comments`	Root Diff Comment List Resource	5.0.2
`all_file_attachment_comments`	Root File Attachment Comment List Resource	5.0.2
`all_general_comments`	Root General Comment List Resource	5.0.1
`all_reviews`	Root Review List Resource	5.0.1
`api_token`	API Token Resource
`api_tokens`	API Token List Resource
`archived_review_request`	Archived Review Request Resource
`archived_review_requests`	Archived Review Request List Resource
`commit_validation`	webapi2.0-commit-validation-resource
`default_reviewer`	Default Reviewer Resource
`default_reviewers`	Default Reviewer List Resource
`diff`	Diff Resource
`diffs`	Diff List Resource
`diff_commit`	Diff Commit Resource	5.0.2
`diff_commits`	Diff Commit List Resource	5.0.2
`diff_context`	Diff Context Resource
`diff_file_attachment`	Diff File Attachment Resource
`diff_file_attachments`	Diff File Attachment List Resource
`diff_validation`	Validate Diff List Resource
`extension`	Extension Resource
`extensions`	Extension List Resource
`file_diff`	File Diff Resource	5.0.2
`file_diffs`	File Diff List Resource	5.0.2
`file_diff_comments`	File Diff Comment List Resource
`file_diff_original`	Original File Resource	5.0.2
`file_diff_patched`	Patched File Resource	5.0.2
`group`	Review Group Resource
`groups`	Review Group List Resource
`hosting_service`	Hosting Service Resource
`hosting_services`	Hosting Service List Resource
`hosting_service_account`	Hosting Service Account Resource
`hosting_service_accounts`	Hosting Service Account List Resource
`info`	Server Info Resource
`muted_review_request`	Muted Review Request Resource
`muted_review_requests`	Muted Review Request List Resource
`oauth_app`	OAuth2 Applications Resource
`oauth_apps`	OAuth2 Applications List Resource
`oauth_token`	OAuth2 Tokens Resource
`oauth_tokens`	OAuth2 Tokens List Resource
`remote_repository`	Remote Repository Resource
`remote_repositories`	Remote Repository List Resource
`repository`	Repository Resource
`repositories`	Repository List Resource
`repository_branches`	Repository Branches Resource	5.0.2
`repository_commits`	Repository Commits Resource	5.0.2
`repository_group`	Repository Group Resource	5.0.2
`repository_groups`	Repository Group List Resource	5.0.2
`repository_info`	Repository Info Resource	5.0.2
`repository_user`	Repository User Resource	5.0.2
`repository_users`	Repository User List Resource	5.0.2
`review`	Review Resource
`reviews`	Review List Resource
`review_diff_comment`	Review Diff Comment Resource	5.0.2
`review_diff_comments`	Review Diff Comment List Resource	5.0.2
`review_draft`	Review Draft Resource
`review_general_comment`	Review General Comment Resource	5.0.2
`review_general_comments`	Review General Comment List Resource	5.0.2
`review_group_user`	Review Group User Resource
`review_group_users`	Review Group User List Resource
`review_reply`	Review Reply Resource	5.0.2
`review_replies`	Review Reply List Resource	5.0.2
`review_reply_draft`	Review Reply Draft Resource	5.0.2
`review_reply_diff_comment`	Review Reply Diff Comment Resource	5.0.2
`review_reply_diff_comments`	Review Reply Diff Comment List Resource	5.0.2
`review_reply_file_attachment_comment`	Review Reply File Attachment Comment Resource	5.0.2
`review_reply_file_attachment_comments`	Review Reply File Attachment Comment List Resource	5.0.2
`review_reply_general_comment`	Review Reply General Comment Resource	5.0.2
`review_reply_general_comments`	Review Reply General Comment List Resource	5.0.2
`review_reply_screenshot_comment`	Review Reply Screenshot Comment Resource	5.0.1
`review_reply_screenshot_comments`	Review Reply Screenshot Comment List Resource	5.0.1
`review_request`	Review Request Resource
`review_requests`	Review Request List Resource
`review_request_change`	Change Resource	5.0.2
`review_request_changes`	Change List Resource	5.0.2
`review_request_draft`	Review Request Draft Resource	5.0.2
`review_request_file_attachment`	File Attachment Resource	5.0.2
`review_request_file_attachments`	File Attachment List Resource	5.0.2
`review_request_file_attachment_comments`	File Attachment Comment List Resource	5.0.2
`review_request_last_update`	Review Request Last Update Resource	5.0.2
`review_request_status_update`	Status Update Resource	5.0.2
`review_request_status_updates`	Status Update List Resource	5.0.2
`root`	Root List Resource
`screenshot`	Screenshot Resource
`screenshots`	Screenshot List Resource
`screenshot_comment`	Review Screenshot Comment Resource
`screenshot_comments`	Screenshot Comment List Resource
`search`	Search Resource
`session`	Session Resource
`user`	User Resource
`users`	User List Resource
`user_file_attachment`	User File Attachment Resource
`user_file_attachments`	User File Attachment List Resource
`validation`	Validation List Resource
`watched`	Watched List Resource
`watched_review_group`	Watched Review Group Resource
`watched_review_groups`	Watched Review Group List Resource
`watched_review_request`	Watched Review Request Resource
`watched_review_requests`	Watched Review Request List Resource
`webhook`	WebHook Resource
`webhooks`	WebHook List Resource

The following URI templates are considered deprecated, and may be removed in a future version.

URI template key	Replacement	Resource	Deprecated In
`branches`	`repository_branches`	Repository Branches Resource	5.0.2
`change`	`review_request_change`	Change Resource	5.0.2
`changes`	`review_request_changes`	Change List Resource	5.0.2
`commit`	`diff_commit`	Diff Commit Resource	5.0.2
`commits`	`repository_commits`	Repository Commits Resource	5.0.2
`diff_comment`	`review_reply_diff_comment`	Review Reply Diff Comment Resource	5.0.2
`diff_comments`	`review_reply_diff_comments`	Review Reply Diff Comment List Resource	5.0.2
`draft`	`review_request_draft`	Review Request Draft Resource	5.0.2
`file`	`file_diff`	File Diff Resource	5.0.2
`files`	`file_diffs`	File Diff List Resource	5.0.2
`file_attachment`	`review_request_file_attachment`	File Attachment Resource	5.0.2
`file_attachments`	`review_request_file_attachments`	File Attachment List Resource	5.0.2
`general_comment`	`review_general_comment`	Review General Comment Resource	5.0.2
`general_comments`	`review_general_comments`	Review General Comment List Resource	5.0.2
`last_update`	`review_request_last_update`	Review Request Last Update Resource	5.0.2
`original_file`	`file_diff_original_file`	Original File Resource	5.0.2
`patched_file`	`file_diff_patched_file`	Patched File Resource	5.0.2
`reply`	`review_reply`	Review Reply Resource	5.0.2
`replies`	`review_replies`	Review Reply List Resource	5.0.2
`reply_draft`	`review_reply_draft`	Review Reply Draft Resource	5.0.2
`status_update`	`review_request_status_update`	Status Update Resource	5.0.2
`status_updates`	`review_request_status_update`	Status Update List Resource	5.0.2

Details¶

Name	`root`
URI	`/api/`
Token Policy ID	`root`
HTTP Methods	GET - Retrieves the list of top-level resources and templates.
Parent Resource	None.
Child Resources	Default Reviewer List Resource Extension List Resource Hosting Service Account List Resource Hosting Service List Resource OAuth2 Applications List Resource OAuth2 Tokens List Resource Repository List Resource Review Group List Resource Review Request List Resource Root Diff Comment List Resource Root File Attachment Comment List Resource Root General Comment List Resource Root Review List Resource Search Resource Server Info Resource Session Resource User List Resource Validation List Resource WebHook List Resource

Links¶

Name	Method	Resource
all_diff_comments	GET	Root List Resource
all_file_attachment_comments	GET	Root List Resource
all_general_comments	GET	Root List Resource
all_reviews	GET	Root List Resource
default_reviewers	GET	Default Reviewer List Resource
extensions	GET	Extension List Resource
groups	GET	Review Group List Resource
hosting_service_accounts	GET	Hosting Service Account List Resource
hosting_services	GET	Hosting Service List Resource
info	GET	Server Info Resource
oauth_apps	GET	OAuth2 Applications List Resource
oauth_tokens	GET	OAuth2 Tokens List Resource
repositories	GET	Repository List Resource
review_requests	GET	Review Request List Resource
search	GET	Search Resource
self	GET	Root List Resource
session	GET	Session Resource
users	GET	User List Resource
validation	GET	Validation List Resource
webhooks	GET	WebHook List Resource

HTTP GET¶

Retrieves the list of top-level resources and templates.

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
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.root+json¶

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

HTTP 200 OK
Content-Length: 16045
Content-Type: application/vnd.reviewboard.org.root+json
ETag: ba65a0e059fec777539f45133c07bdeab549cafa
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "capabilities": {
    "authentication": {
      "client_web_login": false
    },
    "diffs": {
      "base_commit_ids": true,
      "moved_files": true,
      "validation": {
        "base_commit_ids": true
      }
    },
    "extra_data": {
      "json_patching": true
    },
    "review_requests": {
      "commit_ids": true,
      "supports_history": true,
      "trivial_publish": true
    },
    "scmtools": {
      "git": {
        "empty_files": true,
        "symlinks": true
      },
      "mercurial": {
        "empty_files": true
      },
      "perforce": {
        "empty_files": true,
        "moved_files": true
      },
      "svn": {
        "empty_files": true
      }
    },
    "text": {
      "can_include_raw_values": true,
      "markdown": true,
      "per_field_text_types": true
    }
  },
  "links": {
    "all_diff_comments": {
      "href": "https://reviews.example.com/api/diff-comments/",
      "method": "GET"
    },
    "all_file_attachment_comments": {
      "href": "https://reviews.example.com/api/file-attachment-comments/",
      "method": "GET"
    },
    "all_general_comments": {
      "href": "https://reviews.example.com/api/general-comments/",
      "method": "GET"
    },
    "all_reviews": {
      "href": "https://reviews.example.com/api/reviews/",
      "method": "GET"
    },
    "default_reviewers": {
      "href": "https://reviews.example.com/api/default-reviewers/",
      "method": "GET"
    },
    "extensions": {
      "href": "https://reviews.example.com/api/extensions/",
      "method": "GET"
    },
    "groups": {
      "href": "https://reviews.example.com/api/groups/",
      "method": "GET"
    },
    "hosting_service_accounts": {
      "href": "https://reviews.example.com/api/hosting-service-accounts/",
      "method": "GET"
    },
    "hosting_services": {
      "href": "https://reviews.example.com/api/hosting-services/",
      "method": "GET"
    },
    "info": {
      "href": "https://reviews.example.com/api/info/",
      "method": "GET"
    },
    "oauth_apps": {
      "href": "https://reviews.example.com/api/oauth-apps/",
      "method": "GET"
    },
    "oauth_tokens": {
      "href": "https://reviews.example.com/api/oauth-tokens/",
      "method": "GET"
    },
    "repositories": {
      "href": "https://reviews.example.com/api/repositories/",
      "method": "GET"
    },
    "review_requests": {
      "href": "https://reviews.example.com/api/review-requests/",
      "method": "GET"
    },
    "search": {
      "href": "https://reviews.example.com/api/search/",
      "method": "GET"
    },
    "self": {
      "href": "https://reviews.example.com/api/",
      "method": "GET"
    },
    "session": {
      "href": "https://reviews.example.com/api/session/",
      "method": "GET"
    },
    "users": {
      "href": "https://reviews.example.com/api/users/",
      "method": "GET"
    },
    "validation": {
      "href": "https://reviews.example.com/api/validation/",
      "method": "GET"
    },
    "webhooks": {
      "href": "https://reviews.example.com/api/webhooks/",
      "method": "GET"
    }
  },
  "product": {
    "is_release": true,
    "name": "Review Board",
    "package_version": "6.0.1",
    "version": "6.0.1"
  },
  "site": {
    "administrators": [
      {
        "email": "admin@example.com",
        "name": "Example Admin"
      }
    ],
    "time_zone": "UTC",
    "url": "http://example.com/"
  },
  "stat": "ok",
  "uri_templates": {
    "all_diff_comments": "https://reviews.example.com/api/diff-comments/",
    "all_file_attachment_comments": "https://reviews.example.com/api/file-attachment-comments/",
    "all_general_comments": "https://reviews.example.com/api/general-comments/",
    "all_reviews": "https://reviews.example.com/api/reviews/",
    "api_token": "https://reviews.example.com/api/users/{username}/api-tokens/{api_token_id}/",
    "api_tokens": "https://reviews.example.com/api/users/{username}/api-tokens/",
    "archived_review_request": "https://reviews.example.com/api/users/{username}/archived-review-requests/{review_request_id}/",
    "archived_review_requests": "https://reviews.example.com/api/users/{username}/archived-review-requests/",
    "branches": "https://reviews.example.com/api/repositories/{repository_id}/branches/",
    "change": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/",
    "changes": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/",
    "commit": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/{commit_id}/",
    "commit_validation": "https://reviews.example.com/api/validation/commits/",
    "commits": "https://reviews.example.com/api/repositories/{repository_id}/commits/",
    "default_reviewer": "https://reviews.example.com/api/default-reviewers/{default_reviewer_id}/",
    "default_reviewers": "https://reviews.example.com/api/default-reviewers/",
    "diff": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/",
    "diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/",
    "diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/",
    "diff_commit": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/{commit_id}/",
    "diff_commits": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/commits/",
    "diff_context": "https://reviews.example.com/api/review-requests/{review_request_id}/diff-context/",
    "diff_file_attachment": "https://reviews.example.com/api/repositories/{repository_id}/diff-file-attachments/{file_attachment_id}/",
    "diff_file_attachments": "https://reviews.example.com/api/repositories/{repository_id}/diff-file-attachments/",
    "diff_validation": "https://reviews.example.com/api/validation/diffs/",
    "diffs": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/",
    "draft": "https://reviews.example.com/api/review-requests/{review_request_id}/draft/",
    "extension": "https://reviews.example.com/api/extensions/{extension_name}/",
    "extensions": "https://reviews.example.com/api/extensions/",
    "file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/",
    "file_attachment": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/",
    "file_attachment_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/{comment_id}/",
    "file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/file-attachment-comments/",
    "file_attachments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/",
    "file_diff": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/",
    "file_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/diff-comments/",
    "file_diff_original_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/",
    "file_diff_patched_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/",
    "file_diffs": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/",
    "files": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/",
    "general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/{comment_id}/",
    "general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/",
    "group": "https://reviews.example.com/api/groups/{group_name}/",
    "groups": "https://reviews.example.com/api/groups/",
    "hosting_service": "https://reviews.example.com/api/hosting-services/{hosting_service_id}/",
    "hosting_service_account": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/",
    "hosting_service_accounts": "https://reviews.example.com/api/hosting-service-accounts/",
    "hosting_services": "https://reviews.example.com/api/hosting-services/",
    "info": "https://reviews.example.com/api/info/",
    "last_update": "https://reviews.example.com/api/review-requests/{review_request_id}/last-update/",
    "muted_review_request": "https://reviews.example.com/api/users/{username}/muted-review-requests/{review_request_id}/",
    "muted_review_requests": "https://reviews.example.com/api/users/{username}/muted-review-requests/",
    "oauth_app": "https://reviews.example.com/api/oauth-apps/{app_id}/",
    "oauth_apps": "https://reviews.example.com/api/oauth-apps/",
    "oauth_token": "https://reviews.example.com/api/oauth-tokens/{oauth_token_id}/",
    "oauth_tokens": "https://reviews.example.com/api/oauth-tokens/",
    "original_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/original-file/",
    "patched_file": "https://reviews.example.com/api/review-requests/{review_request_id}/diffs/{diff_revision}/files/{filediff_id}/patched-file/",
    "remote_repositories": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/remote-repositories/",
    "remote_repository": "https://reviews.example.com/api/hosting-service-accounts/{account_id}/remote-repositories/{repository_id}/",
    "replies": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/",
    "reply": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/",
    "reply_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/",
    "repositories": "https://reviews.example.com/api/repositories/",
    "repository": "https://reviews.example.com/api/repositories/{repository_id}/",
    "repository_branches": "https://reviews.example.com/api/repositories/{repository_id}/branches/",
    "repository_commits": "https://reviews.example.com/api/repositories/{repository_id}/commits/",
    "repository_group": "https://reviews.example.com/api/repositories/{repository_id}/groups/{group_name}/",
    "repository_groups": "https://reviews.example.com/api/repositories/{repository_id}/groups/",
    "repository_info": "https://reviews.example.com/api/repositories/{repository_id}/info/",
    "repository_user": "https://reviews.example.com/api/repositories/{repository_id}/users/{username}/",
    "repository_users": "https://reviews.example.com/api/repositories/{repository_id}/users/",
    "review": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/",
    "review_diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/diff-comments/{comment_id}/",
    "review_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/diff-comments/",
    "review_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/draft/",
    "review_general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/{comment_id}/",
    "review_general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/general-comments/",
    "review_group_user": "https://reviews.example.com/api/groups/{group_name}/users/{username}/",
    "review_group_users": "https://reviews.example.com/api/groups/{group_name}/users/",
    "review_replies": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/",
    "review_reply": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/",
    "review_reply_diff_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/{comment_id}/",
    "review_reply_diff_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/diff-comments/",
    "review_reply_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/draft/",
    "review_reply_file_attachment_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/{comment_id}/",
    "review_reply_file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/file-attachment-comments/",
    "review_reply_general_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/general-comments/{comment_id}/",
    "review_reply_general_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/general-comments/",
    "review_reply_screenshot_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/{comment_id}/",
    "review_reply_screenshot_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/replies/{reply_id}/screenshot-comments/",
    "review_request": "https://reviews.example.com/api/review-requests/{review_request_id}/",
    "review_request_change": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/{change_id}/",
    "review_request_changes": "https://reviews.example.com/api/review-requests/{review_request_id}/changes/",
    "review_request_draft": "https://reviews.example.com/api/review-requests/{review_request_id}/draft/",
    "review_request_file_attachment": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/",
    "review_request_file_attachment_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/{file_attachment_id}/file-attachment-comments/",
    "review_request_file_attachments": "https://reviews.example.com/api/review-requests/{review_request_id}/file-attachments/",
    "review_request_last_update": "https://reviews.example.com/api/review-requests/{review_request_id}/last-update/",
    "review_request_status_update": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/{status_update_id}/",
    "review_request_status_updates": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/",
    "review_requests": "https://reviews.example.com/api/review-requests/",
    "reviews": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/",
    "root": "https://reviews.example.com/api/",
    "screenshot": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/",
    "screenshot_comment": "https://reviews.example.com/api/review-requests/{review_request_id}/reviews/{review_id}/screenshot-comments/{comment_id}/",
    "screenshot_comments": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/{screenshot_id}/screenshot-comments/",
    "screenshots": "https://reviews.example.com/api/review-requests/{review_request_id}/screenshots/",
    "search": "https://reviews.example.com/api/search/{username}/",
    "session": "https://reviews.example.com/api/session/",
    "status_update": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/{status_update_id}/",
    "status_updates": "https://reviews.example.com/api/review-requests/{review_request_id}/status-updates/",
    "user": "https://reviews.example.com/api/users/{username}/",
    "user_file_attachment": "https://reviews.example.com/api/users/{username}/user-file-attachments/{file_attachment_id}/",
    "user_file_attachments": "https://reviews.example.com/api/users/{username}/user-file-attachments/",
    "users": "https://reviews.example.com/api/users/",
    "validation": "https://reviews.example.com/api/validation/",
    "watched": "https://reviews.example.com/api/users/{username}/watched/",
    "watched_review_group": "https://reviews.example.com/api/users/{username}/watched/review-groups/{watched_obj_id}/",
    "watched_review_groups": "https://reviews.example.com/api/users/{username}/watched/review-groups/",
    "watched_review_request": "https://reviews.example.com/api/users/{username}/watched/review-requests/{watched_obj_id}/",
    "watched_review_requests": "https://reviews.example.com/api/users/{username}/watched/review-requests/",
    "webhook": "https://reviews.example.com/api/webhooks/{webhook_id}/",
    "webhooks": "https://reviews.example.com/api/webhooks/"
  }
}