List all reviews for a pull request

GET

/repos/{owner}/{repo}/pulls/{index}/reviews

repository

Response Example

200 - Example 1

[
    {
        "body": "string",
        "comments_count": 0,
        "commit_id": "string",
        "dismissed": true,
        "html_url": "string",
        "id": 0,
        "official": true,
        "pull_request_url": "string",
        "stale": true,
        "state": "string",
        "submitted_at": "2019-08-24T14:15:22Z",
        "team": {
            "can_create_org_repo": true,
            "description": "string",
            "id": 0,
            "includes_all_repositories": true,
            "name": "string",
            "organization": {
                "avatar_url": "string",
                "description": "string",
                "full_name": "string",
                "id": 0,
                "location": "string",
                "repo_admin_change_team_access": true,
                "username": "string",
                "visibility": "string",
                "website": "string"
            },
            "permission": "none",
            "units": [
                "repo.code",
                "repo.issues",
                "repo.ext_issues",
                "repo.wiki",
                "repo.pulls",
                "repo.releases",
                "repo.projects",
                "repo.ext_wiki"
            ]
        },
        "user": {
            "active": true,
            "avatar_url": "string",
            "created": "2019-08-24T14:15:22Z",
            "description": "string",
            "email": "user@example.com",
            "followers_count": 0,
            "following_count": 0,
            "full_name": "string",
            "id": 0,
            "is_admin": true,
            "language": "string",
            "last_login": "2019-08-24T14:15:22Z",
            "location": "string",
            "login": "string",
            "prohibit_login": true,
            "restricted": true,
            "starred_repos_count": 0,
            "visibility": "string",
            "website": "string"
        }
    }
]

Request

Path Params

owner

string

required

owner of the repo

repo

string

required

name of the repo

index

integer

required

index of the pull request

Query Params

page

integer

optional

page number of results to return (1-based)

limit

integer

optional

page size of results

Responses

🟢200OK

application/json

Body

array of:

body

string

optional

comments_count

integer <int64>

optional

commit_id

string

optional

dismissed

boolean

optional

html_url

string

optional

integer <int64>

optional

official

boolean

optional

pull_request_url

string

optional

stale

boolean

optional

state

string

optional

ReviewStateType review state type

submitted_at

string <date-time>

optional

team

object (Team)

optional

Team represents a team in an organization

can_create_org_repo

boolean

optional

description

string

optional

integer <int64>

optional

includes_all_repositories

boolean

optional

name

string

optional

organization

object (Organization)

optional

Organization represents an organization

permission

enum<string>

optional

Allowed values:

nonereadwriteadminowner

units

array[string]

optional

Example:

["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"]

user

object (User)

optional

User represents a user

active

boolean

optional

Is user active

avatar_url

string

optional

URL to the user's avatar

created

string <date-time>

optional

description

string

optional

the user's description

string <email>

optional

followers_count

integer <int64>

optional

user counts

following_count

integer <int64>

optional

full_name

string

optional

the user's full name

integer <int64>

optional

the user's id

is_admin

boolean

optional

Is the user an administrator

language

string

optional

User locale

last_login

string <date-time>

optional

location

string

optional

the user's location

string

optional

the user's username

prohibit_login

boolean

optional

Is user login prohibited

restricted

boolean

optional

Is user restricted

starred_repos_count

integer <int64>

optional

visibility

string

optional

User visibility level option: public, limited, private

website

string

optional

the user's website

🟠404404

Modified at 2022-09-10 23:12:52

create review requests for a pull request

Create a review to an pull request