> For the complete documentation index, see [llms.txt](https://codemash.gitbook.io/codemash/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codemash.gitbook.io/codemash/sdks/database/collections/get-collection-indexes.md).

# Get Collection Indexes

Lists the index key patterns of a collection (read-only).

**Hub only.** Lists the MongoDB indexes of one collection, so you can check which fields are indexed before sorting or filtering on them. Read-only — indexes are created on the MongoDB side. `GET /{version}/database/collections/{collectionName}/indexes` The answer's `indexes` is a list of `{ name, keys: [{ field, order }] }` (`order` is `1` ascending or `-1` descending). A sort on a field is fast only when the field is the **first** key of an index. Permission: `database:read` on the collection. AI tool: `get_collection_indexes`.

This method is on the **Hub** surface (`norbix.hub.database`) — call it from admin tooling or IaC.

{% hint style="info" %}
These examples assume the SDK is installed and your credentials are set as environment variables — each client reads them automatically, so the constructors below take no arguments. See [Install a Norbix SDK](/codemash/sdks/install.md).
{% endhint %}

{% tabs %}
{% tab title="JavaScript / TypeScript" %}

```ts
import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.hub.database.getCollectionIndexes({
  collectionName: 'orders',
  databaseIntegrationId: 'int_4kX9mQvR2tYw7ZbC1dFgHj',
});
```

{% endtab %}

{% tab title=".NET" %}

```csharp
using Norbix.Sdk;
using Norbix.Sdk.Types.Hub;

using var client = new NorbixClient();

var result = await client.Database.GetCollectionIndexesAsync(new GetCollectionIndexes
{
    CollectionName = "orders",
    DatabaseIntegrationId = "int_4kX9mQvR2tYw7ZbC1dFgHj",
});
```

{% endtab %}

{% tab title="Python" %}

```python
from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.database.get_collection_indexes(
    collectionName="orders",
    databaseIntegrationId="int_4kX9mQvR2tYw7ZbC1dFgHj",
)
```

{% endtab %}

{% tab title="Go" %}

```go
c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.Hub.Database.GetCollectionIndexes(ctx, "orders", map[string]any{
	"databaseIntegrationId": "int_4kX9mQvR2tYw7ZbC1dFgHj",
}, &result)
```

{% endtab %}

{% tab title="Dart / Flutter" %}

```dart
import 'package:norbix/norbix_hub.dart';

final hub = NorbixHub();

final result = await hub.database.getCollectionIndexes(collectionName: 'orders', body: {
  'databaseIntegrationId': 'int_4kX9mQvR2tYw7ZbC1dFgHj',
});
```

{% endtab %}

{% tab title="Swift" %}

```swift
import NorbixHub

let client = try NorbixHubClient()

let result = try await client.database.getCollectionIndexes([
    "collectionName": "orders",
    "databaseIntegrationId": "int_4kX9mQvR2tYw7ZbC1dFgHj",
])
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
import ai.norbix.sdk.hub.NorbixHub

val hub = NorbixHub()

val result = hub.database.getCollectionIndexes(mapOf(
    "collectionName" to "orders",
    "databaseIntegrationId" to "int_4kX9mQvR2tYw7ZbC1dFgHj",
))
```

{% endtab %}

{% tab title="CLI" %}

```sh
norbix hub db collection indexes get --collectionName orders --databaseIntegrationId int_4kX9mQvR2tYw7ZbC1dFgHj
```

{% endtab %}
{% endtabs %}

## In Cloud

Manage this visually in Cloud — see [Database → Collections](/codemash/cloud/database/collections.md).

## API reference

Full request and response for this endpoint: [Get Collection Indexes](/codemash/api-reference/database/collections/get-collection-indexes.md).
