# List incoming reports

GET

/projects/{projectId}/reports

```js
const url = 'https://zkao.io/api/v1/projects/example/reports?page=1&limit=50&status=NEW';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request GET \
  --url 'https://zkao.io/api/v1/projects/example/reports?page=1&limit=50&status=NEW' \
  --header 'Authorization: Bearer <token>'
```

* Production`zkao.io/api/v1/projects/{projectId}/reports`
* Staging`staging.zkao.io/api/v1/projects/{projectId}/reports`

Requires scope: `read`. Vulnerability reports the programme has received, newest first. Optionally filter by `status`.

`publicId` is what `investigateReport` takes. `intakeState` says whether the report has been read and split into claims yet: an investigation waits for `COMPLETE`, so a `PENDING` or `RUNNING` report is one to come back to rather than one to retry.

## Authorizations

* **[bearerAuth](https://docs.zkao.io/api/#bearerauth)**

## Parameters

### Path Parameters

* **projectId**

  required

  string

### Query Parameters

* **page**

  integer

  default: 1 >= 1

* **limit**

  integer

  default: 50 >= 1 <= 100

* **status**

  string

  Allowed values: NEW TRIAGING NEEDS_INFO ACCEPTED DUPLICATE REJECTED

  Only reports in this triage status.

## Responses

### 200

OK

application/json

object

* **items**

  required

  Array\<object>

  object

  * **publicId**

    required

    The identifier `investigateReport` takes.

    string

  * **title**

    required

    string

  * **source**

    required

    How it arrived, including GitHub private reports, API submissions, and file imports.

    string

  * **claimedSeverity**

    One of:

    string

    string

    Allowed values: CRITICAL HIGH MEDIUM LOW INFO

    null

    null

  * **status**

    required

    string

    Allowed values: NEW TRIAGING NEEDS_INFO ACCEPTED DUPLICATE REJECTED

  * **intakeState**

    required

    Whether the report has been read and split into claims. An investigation waits for COMPLETE.

    string

    Allowed values: PENDING RUNNING REVIEW COMPLETE FAILED

  * **evaluationState**

    How the investigation is going, or null if none has run.

    string | null

    Allowed values: QUEUED RUNNING COMPLETE FAILED

  * **reporterName**

    string | null

  * **reporterGithubLogin**

    string | null

  * **githubUrl**

    The GitHub advisory it arrived as.

    string | null

  * **acknowledgedAt**

    string | null format: date-time

  * **createdAt**

    required

    string format: date-time

* **page**

  required

  integer

* **limit**

  required

  integer

* **total**

  required

  integer

##### Example

```json
{
  "items": [
    {
      "claimedSeverity": "CRITICAL",
      "status": "NEW",
      "intakeState": "PENDING",
      "evaluationState": "QUEUED"
    }
  ]
}
```

### 400

Invalid request

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 401

Missing, malformed, expired, or revoked token

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 403

The token lacks the required scope

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 404

Resource not in this token’s project or repo allowlist

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```
