# list_indexes

Source: <https://everruns.com/docs/api/operations/list_indexes/>

GET

/v1/knowledge-indexes

Select code samplecURL (shell:curl)

```js
const url = 'https://app.everruns.com/api/v1/knowledge-indexes';
const options = {method: 'GET'};


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://app.everruns.com/api/v1/knowledge-indexes
```

* Production APIapp.everruns.com/api/v1/knowledge-indexes

List knowledge indexes.

## Parameters

### Query Parameters

**search**

string | null

Substring filter applied to index name and description.

**include\_archived**

boolean | null

When `true`, also returns archived knowledge indexes.

## Responses

### 200

List knowledge indexes

Media typeapplication/json

Response wrapper for list endpoints. All list endpoints return responses wrapped in a `data` field.

object

**data**

required

Array of items returned by the list operation.

Array\<object>

Response body for a knowledge index.

object

**archived\_at**

Timestamp when this resource was archived, if any (RFC 3339).

string | null format: date-time

**created\_at**

required

Timestamp when this resource was created (RFC 3339).

string format: date-time

**deleted\_at**

Timestamp when this resource was soft-deleted, if any (RFC 3339).

string | null format: date-time

**description**

Human-readable description. Safe to render in user-facing messages.

string | null

**document\_count**

required

Number of documents currently retained by this index.

integer

**embedding\_model\_id**

required

Embedding model used to embed chunks. Required.

string

**id**

required

Prefixed public identifier. See [ID Schema](https://everruns.com/docs/advanced/id-schema/).

string

**last\_sync\_error**

Sanitized failure reason from the last failed sync, if any.

string | null

**last\_synced\_at**

Timestamp of the last successful sync, if any (RFC 3339).

string | null format: date-time

**name**

required

Human-readable name. Safe to render in user-facing messages.

string

**source\_config**

required

Non-secret source coordinates. Never holds credentials.

**source\_type**

required

External source type. One of `github`, `git`.

string

**status**

required

Current lifecycle status.

string

**sync\_status**

required

Syncout pipeline state. One of `idle`, `pending`, `syncing`, `synced`, `failed`.

string

**updated\_at**

required

Timestamp when this resource was last updated (RFC 3339).

string format: date-time

**vector\_dim**

Embedding dimension, recorded on first successful sync.

integer | null format: int32

##### Example

```json
{
  "data": [
    {
      "id": "kidx_01933b5a000070008000000000000001"
    }
  ]
}
```