Reviews
List reviews
List review runs and their statuses.
TypeScript SDKThe npm client, generated from the API spec.Python SDKThe PyPI client, sync and async.
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/reviews | read:reviews |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Query parameters
repositorydefault
[]array<string>Only reviews on these repositories, each as owner/name. Repeat the parameter for several.
pull_request_numberdefault
[]array<integer>Only reviews on these pull request numbers. Repeat the parameter for several.
statusdefault
[]array<CodeReviewRunStatus>Only reviews in these statuses. Repeat the parameter for several.
startstring, date-time
Only reviews created at or after this time.
endstring, date-time
Only reviews created at or before this time.
limitdefault
50integercursorstring
curl "https://api.ellipsis.dev/v1/reviews" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
for item in client.reviews.list():
print(item)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
for await (const item of await client.reviews.list()) {
console.log(item);
}Request
Response
Example response, 200
{
"has_more": false,
"next_cursor": "string",
}