List Indexes

GET

https://acme.captain.dev/v1/indexes

GET

/v1/indexes

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/indexes",
    headers=headers,
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Retrieved

{
  "indexes": [
    {
      "name": "products",
      "status": "ready",
      "record_count": 12840,
      "staged_records": 12840,
      "staged_documents": 12840,
      "pending_changes": false,
      "staged_changes_since_build": false,
      "object_search": true,
      "build_id": "b20260928211503",
      "last_job": "job_20260928211502_4f9c1a",
      "last_build_at": 1759094251,
      "created_at": 1759093140,
      "serving": {
        "build": "b20260928211503",
        "records": 12840,
        "documents": 12840
      }
    },
    {
      "name": "products-staging",
      "status": "empty",
      "record_count": 0,
      "staged_records": 0,
      "staged_documents": 0,
      "pending_changes": false,
      "staged_changes_since_build": false,
      "object_search": true,
      "build_id": null,
      "last_job": null,
      "last_build_at": null,
      "created_at": 1759430001,
      "serving": null
    }
  ],
  "limits": {
    "max_documents": null,
    "documents_per_request": 1000,
    "max_records": null
  }
}

List the indexes the key writes, with the fields Get Index returns.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Response

indexes

indexeslist of objectsOptional

limitsobjectOptional