Review Group List Resource¶

Provides information on review groups.

Review groups are groups of users that can be listed as an intended reviewer on a review request.

Version Changed:: 5.0.6: Added support for ?invite-only and ?show-invisible query arguments for the list resource.

Details¶

Name	`groups`
URI	`/api/groups/`
Token Policy ID	`group`
HTTP Methods	GET - Retrieves the list of review groups on the site. POST - Creates a new review group.
Parent Resource	Root List Resource
Child Resources	Review Group Resource

Links¶

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

HTTP GET¶

Retrieves the list of review groups on the site.

The list of review groups can be filtered down using the q and displayname parameters.

Setting q to a value will by default limit the results to group names starting with that value. This is a case-insensitive comparison.

If displayname is set to 1, the display names will also be checked along with the username. displayname is ignored if q is not set.

For example, accessing /api/groups/?q=dev&displayname=1 will list any groups with a name or display name starting with dev.

Request Parameters¶

counts-onlyBoolean	If specified, a single `count` field is returned with the number of results, instead of the results themselves.
displaynameBoolean	Specifies whether `q` should also match the beginning of the display name.
invite-onlyBoolean	Whether to limit results to accessible invite-only review groups. Added in 5.0.6
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.
qString	The string that the group name (or the display name when using `displayname`) must start with in order to be included in the list. This is case-insensitive.
show-invisibleBoolean	Whether to include accessible invisible review groups in the results. Added in 5.0.6
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.

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.

HTTP POST¶

Creates a new review group.

This will create a brand new review group with the given name and display name. The group will be public by default, unless specified otherwise.

Extra data can be stored later lookup. See Storing/Accessing Extra Data for more information.

Request Parameters¶

display_nameString	Required The human-readable name of the group. Added in 1.6.14
nameString	Required The name of the group. Added in 1.6.14
invite_onlyBoolean	Whether or not the group is invite-only. The default is false. Added in 1.6.14
mailing_listString	The e-mail address that all posts on a review group are sent to. Added in 1.6.14
visibleBoolean	Whether or not the group is visible to users who are not members. The default is true. Added in 1.6.14

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.
208 - Invalid UserHTTP 400 - Bad Request	User does not exist.
223 - Group Already ExistsHTTP 409 - Conflict	A group with this name already exists.

Examples¶

application/vnd.reviewboard.org.review-groups+json¶

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

HTTP 200 OK
Content-Length: 2743
Content-Type: application/vnd.reviewboard.org.review-groups+json
ETag: ba9709199ecb4db49d73edcdf263814e1e318a16
Item-Content-Type: application/vnd.reviewboard.org.review-group+json
Vary: Accept, Cookie
X-Content-Type-Options: nosniff

{
  "groups": [
    {
      "absolute_url": "https://reviews.example.com/groups/devgroup/",
      "display_name": "Dev Group",
      "extra_data": {},
      "id": 1,
      "invite_only": false,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/groups/devgroup/",
          "method": "DELETE"
        },
        "review_group_users": {
          "href": "https://reviews.example.com/api/groups/devgroup/users/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/groups/devgroup/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/groups/devgroup/",
          "method": "PUT"
        }
      },
      "mailing_list": "devgroup@example.com",
      "name": "devgroup",
      "url": "/groups/devgroup/",
      "visible": true
    },
    {
      "absolute_url": "https://reviews.example.com/groups/emptygroup/",
      "display_name": "Empty Group",
      "extra_data": {},
      "id": 3,
      "invite_only": false,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/groups/emptygroup/",
          "method": "DELETE"
        },
        "review_group_users": {
          "href": "https://reviews.example.com/api/groups/emptygroup/users/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/groups/emptygroup/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/groups/emptygroup/",
          "method": "PUT"
        }
      },
      "mailing_list": "",
      "name": "emptygroup",
      "url": "/groups/emptygroup/",
      "visible": true
    },
    {
      "absolute_url": "https://reviews.example.com/groups/newgroup/",
      "display_name": "New Group",
      "extra_data": {},
      "id": 2,
      "invite_only": false,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/groups/newgroup/",
          "method": "DELETE"
        },
        "review_group_users": {
          "href": "https://reviews.example.com/api/groups/newgroup/users/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/groups/newgroup/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/groups/newgroup/",
          "method": "PUT"
        }
      },
      "mailing_list": "newgroup@example.com",
      "name": "newgroup",
      "url": "/groups/newgroup/",
      "visible": true
    },
    {
      "absolute_url": "https://reviews.example.com/groups/privgroup/",
      "display_name": "Private Group",
      "extra_data": {},
      "id": 4,
      "invite_only": false,
      "links": {
        "delete": {
          "href": "https://reviews.example.com/api/groups/privgroup/",
          "method": "DELETE"
        },
        "review_group_users": {
          "href": "https://reviews.example.com/api/groups/privgroup/users/",
          "method": "GET"
        },
        "self": {
          "href": "https://reviews.example.com/api/groups/privgroup/",
          "method": "GET"
        },
        "update": {
          "href": "https://reviews.example.com/api/groups/privgroup/",
          "method": "PUT"
        }
      },
      "mailing_list": "",
      "name": "privgroup",
      "url": "/groups/privgroup/",
      "visible": true
    }
  ],
  "links": {
    "create": {
      "href": "https://reviews.example.com/api/groups/",
      "method": "POST"
    },
    "self": {
      "href": "https://reviews.example.com/api/groups/",
      "method": "GET"
    }
  },
  "stat": "ok",
  "total_results": 4
}