# List repositories

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

## Contents

**Operations**

- [GET /api/v1/external/coding/repos](#scalar-operation-get-apiv1externalcodingrepos)

**Schemas**

- [ExternalRepositoryListResponse](#scalar-schema-externalrepositorylistresponse)
- [CodingRepositoryRead](#scalar-schema-codingrepositoryread)
- [RepositoryGithubDeployRead](#scalar-schema-repositorygithubdeployread)
- [RepositoryStoreRead](#scalar-schema-repositorystoreread)
- [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

### Repositories

The repositories connected to your workspace. List them, change a repository's settings, and make or undo a direct text edit on a live site without starting a full run.

## Operations

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

### List repositories

- **Method:** `GET`
- **Path:** `/api/v1/external/coding/repos`
- **Operation ID:** `listRepos`
- **Tags:** Repositories

List the active repositories in your workspace that runs can target, ordered by provider and full name. Requires the `coding:repos:read` scope.

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

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

#### Query parameters

- **`customer_id`**: `string | null`, format: `uuid`

#### Responses

##### 200 Request fulfilled, document follows

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

[ExternalRepositoryListResponse](#scalar-schema-externalrepositorylistresponse)

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

**Generated example:**

```json
{
  "repos": [
    {
      "allow_automation_changes": false,
      "capabilities": {
        "additionalProperty": "anything"
      },
      "clone_url": "",
      "created_at": "",
      "customer_id": "",
      "default_branch": "",
      "display_name": "",
      "full_name": "",
      "github_deploy": {
        "at": "",
        "environment": "",
        "state": "",
        "url": ""
      },
      "html_url": "",
      "id": "",
      "protected_paths": [
        ""
      ],
      "provider": "",
      "repo_url": "",
      "status": "",
      "store": {
        "needs": "",
        "needs_owner": true,
        "state": "",
        "version": ""
      },
      "trust_owner_changes": true,
      "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-externalrepositorylistresponse"></a>

### ExternalRepositoryListResponse

**Type:** `object`

- **`repos` (required)**: array of [CodingRepositoryRead](#scalar-schema-codingrepositoryread)

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

**Generated example:**

```json
{
  "repos": [
    {
      "allow_automation_changes": false,
      "capabilities": {
        "additionalProperty": "anything"
      },
      "clone_url": "",
      "created_at": "",
      "customer_id": "",
      "default_branch": "",
      "display_name": "",
      "full_name": "",
      "github_deploy": {
        "at": "",
        "environment": "",
        "state": "",
        "url": ""
      },
      "html_url": "",
      "id": "",
      "protected_paths": [
        ""
      ],
      "provider": "",
      "repo_url": "",
      "status": "",
      "store": {
        "needs": "",
        "needs_owner": true,
        "state": "",
        "version": ""
      },
      "trust_owner_changes": true,
      "updated_at": ""
    }
  ]
}
```

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

### CodingRepositoryRead

**Type:** `object`

- **`capabilities` (required)**: `object`
- **`clone_url` (required)**: `string`
- **`created_at` (required)**: `string`, format: `date-time`
- **`default_branch` (required)**: `string`
- **`full_name` (required)**: `string`
- **`id` (required)**: `string`, format: `uuid`
- **`protected_paths` (required)**: `array of string`
- **`provider` (required)**: `string`
- **`repo_url` (required)**: `string`
- **`status` (required)**: `string`
- **`updated_at` (required)**: `string`, format: `date-time`
- **`allow_automation_changes`**: `boolean`, default: `false`
- **`customer_id`**: `string | null`, format: `uuid`
- **`display_name`**: `string | null`
- **`github_deploy`**: [RepositoryGithubDeployRead](#scalar-schema-repositorygithubdeployread) | `null`
- **`html_url`**: `string | null`
- **`store`**: [RepositoryStoreRead](#scalar-schema-repositorystoreread) | `null`
- **`trust_owner_changes`**: `boolean`, default: `true`

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

**Generated example:**

```json
{
  "allow_automation_changes": false,
  "capabilities": {
    "additionalProperty": "anything"
  },
  "clone_url": "",
  "created_at": "",
  "customer_id": "",
  "default_branch": "",
  "display_name": "",
  "full_name": "",
  "github_deploy": {
    "at": "",
    "environment": "",
    "state": "",
    "url": ""
  },
  "html_url": "",
  "id": "",
  "protected_paths": [
    ""
  ],
  "provider": "",
  "repo_url": "",
  "status": "",
  "store": {
    "needs": "",
    "needs_owner": true,
    "state": "",
    "version": ""
  },
  "trust_owner_changes": true,
  "updated_at": ""
}
```

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

### RepositoryGithubDeployRead

**Type:** `object`

- **`at` (required)**: `string`, format: `date-time`
- **`environment` (required)**: `string`
- **`state` (required)**: `string`
- **`url`**: `string | null`

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

**Generated example:**

```json
{
  "at": "",
  "environment": "",
  "state": "",
  "url": ""
}
```

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

### RepositoryStoreRead

**Type:** `object`

- **`needs_owner` (required)**: `boolean`
- **`state` (required)**: `string`
- **`needs`**: `string | null`
- **`version`**: `string | null`

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

**Generated example:**

```json
{
  "needs": "",
  "needs_owner": true,
  "state": "",
  "version": ""
}
```

<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-8"></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.