# List bug-scan findings

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [GET /api/v1/external/coding/findings](#scalar-operation-get-apiv1externalcodingfindings)

**Schemas**

- [BugFindingListResponse](#scalar-schema-bugfindinglistresponse)
- [BugFindingRead](#scalar-schema-bugfindingread)
- [EvidenceMedia](#scalar-schema-evidencemedia)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### Findings

Bugs Syndai's scanner found in your repositories. List findings, read or change a repository's weekly scan setting, or start a scan now; each scan is capped by the per-scan limit.

## Operations

<a id="scalar-operation-get-apiv1externalcodingfindings"></a>

### List bug-scan findings

- **Method:** `GET`
- **Path:** `/api/v1/external/coding/findings`
- **Operation ID:** `listBugFindings`
- **Tags:** Findings

List the tenant's bug-scan findings in every state (`open`, `running`, `done`, `wontfix`), open first, then by priority, then most recently updated. Each carries the full finding and, once a fix run is linked, its newest PR. An app finding (`finding.category` = `ui`) adds `media` (its recorded clip, then the failed step's still, as short-lived signed URLs) and `expected` (the criterion text of the saved walkthrough it breaks, or the rule in plain words). Fix one by sending its `id` as `backlog_task_id` on POST /runs; dismiss one with a reason on POST /backlog/{id}/dismiss.

**Servers:** [Inherited servers](#scalar-context-global-servers)

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Query parameters

- **`customer_id`**: `string | null`, format: `uuid`
- **`repository_id`**: `string | null`, format: `uuid`
- **`state`**: `null | string`, possible values: `"open", "running", "done", "wontfix", null`

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[BugFindingListResponse](#scalar-schema-bugfindinglistresponse)

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "items": [
    {
      "created_at": "",
      "dismiss_reason": "",
      "expected": "",
      "finding": {
        "additionalProperty": "anything"
      },
      "id": "",
      "media": [
        {
          "alt": "",
          "height": 1,
          "id": "",
          "kind": "",
          "truncated": true,
          "url": "",
          "url_expires_at": "",
          "width": 1
        }
      ],
      "pr_state": "",
      "pr_url": "",
      "priority": 1,
      "prompt": "",
      "repository_id": "",
      "run_id": "",
      "state": "",
      "title": "",
      "updated_at": ""
    }
  ]
}
```

##### 400, 401, 403, 404

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access
- `404` Resource not found

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-2)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-3"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-bugfindinglistresponse"></a>

### BugFindingListResponse

**Type:** `object`

- **`items` (required)**: array of [BugFindingRead](#scalar-schema-bugfindingread)

<a id="scalar-example-4"></a>

**Generated example:**

```json
{
  "items": [
    {
      "created_at": "",
      "dismiss_reason": "",
      "expected": "",
      "finding": {
        "additionalProperty": "anything"
      },
      "id": "",
      "media": [
        {
          "alt": "",
          "height": 1,
          "id": "",
          "kind": "",
          "truncated": true,
          "url": "",
          "url_expires_at": "",
          "width": 1
        }
      ],
      "pr_state": "",
      "pr_url": "",
      "priority": 1,
      "prompt": "",
      "repository_id": "",
      "run_id": "",
      "state": "",
      "title": "",
      "updated_at": ""
    }
  ]
}
```

<a id="scalar-schema-bugfindingread"></a>

### BugFindingRead

**Type:** `object`

- **`created_at` (required)**: `string`, format: `date-time`
- **`finding` (required)**: `object`
- **`id` (required)**: `string`, format: `uuid`
- **`priority` (required)**: `integer`
- **`prompt` (required)**: `string`
- **`repository_id` (required)**: `string`, format: `uuid`
- **`state` (required)**: `string`
- **`title` (required)**: `string`
- **`updated_at` (required)**: `string`, format: `date-time`
- **`dismiss_reason`**: `string | null`
- **`expected`**: `string | null`
- **`media`**: array of [EvidenceMedia](#scalar-schema-evidencemedia)
- **`pr_state`**: `string | null`
- **`pr_url`**: `string | null`
- **`run_id`**: `string | null`, format: `uuid`

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "created_at": "",
  "dismiss_reason": "",
  "expected": "",
  "finding": {
    "additionalProperty": "anything"
  },
  "id": "",
  "media": [
    {
      "alt": "",
      "height": 1,
      "id": "",
      "kind": "",
      "truncated": true,
      "url": "",
      "url_expires_at": "",
      "width": 1
    }
  ],
  "pr_state": "",
  "pr_url": "",
  "priority": 1,
  "prompt": "",
  "repository_id": "",
  "run_id": "",
  "state": "",
  "title": "",
  "updated_at": ""
}
```

<a id="scalar-schema-evidencemedia"></a>

### EvidenceMedia

**Type:** `object`

- **`alt` (required)**: `string`
- **`id` (required)**: `string`, format: `uuid`
- **`kind` (required)**: `string`
- **`truncated` (required)**: `boolean`
- **`url` (required)**: `string`
- **`url_expires_at` (required)**: `string`, format: `date-time`
- **`height`**: `integer | null`
- **`width`**: `integer | null`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "alt": "",
  "height": 1,
  "id": "",
  "kind": "",
  "truncated": true,
  "url": "",
  "url_expires_at": "",
  "width": 1
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.