Skip to content
forgit api docs

List effective default reviewers

GET
/repositories/{workspace}/{repo_slug}/effective-default-reviewers

Returns the repository’s effective default reviewers. This includes both default reviewers defined at the repository level as well as those inherited from its project.

These are the users that are automatically added as reviewers on every new pull request that is created.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The paginated list of effective default reviewers

Media type application/json
Paginated Default Reviewer and Type

A paginated list of default reviewers with reviewer type.

object
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
>= 1
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
>= 1
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
values
Array<object>
0 unique items
Default Reviewer and Type

Object containing a user that is a default reviewer and the type of reviewer

object
type
required
string
reviewer_type
string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
links
object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
repositories
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
account_id

The user’s Atlassian account ID.

string
account_status

The status of the account. Currently the only possible value is “active”, but more values may be added in the future.

string
has_2fa_enabled
boolean
nickname

Account name defined by the owner. Should be used instead of the “username” field. Note that “nickname” cannot be used in place of “username” in URLs and queries, as “nickname” is not guaranteed to be unique.

string
is_staff
boolean
key
additional properties
any
Examples
Example response 
{
  "pagelen": 20,
  "values": [
    {
      "user": {
        "display_name": "Patrick Wolf",
        "uuid": "{9565301a-a3cf-4b5d-88f4-dd6af8078d7e}"
      },
      "reviewer_type": "project",
      "type": "default_reviewer"
    },
    {
      "user": {
        "display_name": "Davis Lee",
        "uuid": "{f0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6}"
      },
      "reviewer_type": "repository",
      "type": "default_reviewer"
    }
  ],
  "page": 1,
  "size": 2
}

403

Section titled “ 403 ”

If the authenticated user does not have access to view the default reviewers

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}