---
title: "List Reviews"
method: GET
path: "/v1/reviews"
tags: ["v1", "Reviews"]
---

# List Reviews

`GET /v1/reviews`

## Request

- Base URL: `https://api.ellipsis.dev`
- URL: `https://api.ellipsis.dev/v1/reviews`
- Auth: HTTP bearer

List code reviews, newest first.

## Query parameters

- `repository` string[], nullable: Only reviews of these repositories, by name.
- `pull_request_number` integer[], nullable: Only reviews of these pull request numbers.
- `status` CodeReviewStatus[], nullable: Only reviews in these states.
- `start` string, date-time, nullable: Only reviews created at or after this time.
- `end` string, date-time, nullable: Only reviews created before this time.
- `limit` integer
- `cursor` string, nullable: The `next_cursor` of the previous page.

## Headers

- `user-agent` string, nullable

## Response `200`

Successful Response

- ReviewsListResponse
  - `has_more` boolean: Whether more results exist past this page.
  - `next_cursor` string, nullable: Pass as `cursor` to fetch the next page. Null on the last page. Opaque — echo it back rather than parsing it.
  - `reviews` ReviewSummary[], required
    - `base_sha` string, required
    - `blocking` integer, required: Blocking comments posted to GitHub.
    - `created_at` string, date-time, required
    - `error` string, nullable
    - `event` 'COMMENT' | 'APPROVE' | 'REQUEST_CHANGES': The GitHub review event the platform submitted, as GitHub names it.
    - `finalized_at` string, date-time, nullable
    - `github_review_id` integer, nullable: The GitHub review id once posted.
    - `head_sha` string, required: The commit the review is anchored at.
    - `id` string, required
    - `non_blocking` integer, required: Comments posted to GitHub that do not block.
    - `pull_request` PullRequest, required: A GitHub pull request. A session's pull requests are read live. A review's is kept as it was when the review ran.
      - `additions` integer, nullable: Lines added, null until GitHub reports them.
      - `author` GithubAccountSnippet, required: Sometimes the GitHub API returns a user of github (can include bots) using this snippet instead of the full GithubAccount model. One example, is when the API returns a pull request. This is the least amount of info we need to represent a GitHub account.
        - `avatar_url` string, required
        - `id` integer, required
        - `login` string, required
        - `name` string, nullable, required
        - `type` 'User' | 'Organization' | 'Bot' | 'Mannequin', required
      - `base` PullRequestBranch, required: One side of a pull request, a branch and the commit it pointed at.
        - `ref` string, required: The branch name.
        - `sha` string, required: The commit the branch pointed at.
      - `changed_files` integer, nullable: Files changed, null until GitHub reports them.
      - `commits` integer, nullable: Commits, null until GitHub reports them.
      - `created_at` string, date-time, required
      - `deletions` integer, nullable: Lines deleted, null until GitHub reports them.
      - `head` PullRequestBranch, required: One side of a pull request, a branch and the commit it pointed at.
        - `ref` string, required: The branch name.
        - `sha` string, required: The commit the branch pointed at.
      - `id` integer, required: The pull request's GitHub id.
      - `merged_at` string, date-time, nullable
      - `number` integer, required
      - `repository` GithubRepositorySnippet, required: A GitHub repository, named by its owner and name.
        - `id` integer, required: The GitHub repository id.
        - `name` string, required: The repository name.
        - `owner` string, required: The repository owner's login.
      - `status` 'open' | 'draft' | 'merged' | 'closed', required
      - `title` string, required
      - `updated_at` string, date-time, required
      - `url` string, required: The pull request on GitHub.
    - `repository` GithubRepositorySnippet, required: A GitHub repository, named by its owner and name.
      - `id` integer, required: The GitHub repository id.
      - `name` string, required: The repository name.
      - `owner` string, required: The repository owner's login.
    - `status` 'running' | 'posting' | 'posted' | 'empty' | 'failed', required

## Other responses

- `400`: The request is invalid or combines incompatible fields.
- `401`: The bearer token is missing, invalid, or revoked.
- `403`: The credential may not perform this action, or the account is blocked.
- `422`: Validation Error

---

[API](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api.md) - [All operations](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/revisions/344b16df9a1a?raw)