List Collections

GET

https://api.runcaptain.com/v2/collections

GET

/v2/collections

1 import requests
2 
3 BASE_URL = "https://api.runcaptain.com"
4 API_KEY = "your_api_key"
5 ORG_ID = "your_organization_id"
6 
7 headers = {
8     "Authorization": f"Bearer {API_KEY}",
9     "X-Organization-ID": ORG_ID
10 }
11 
12 response = requests.get(
13     f"{BASE_URL}/v2/collections",
14     headers=headers,
15     timeout=30.0
16 )
17 
18 if response.status_code == 200:
19     data = response.json()
20     collections = data.get('collections', [])
21     print(f"Found {len(collections)} collection(s):")
22     for col in collections:
23         print(f"  - {col.get('collection_name')}")
24 else:
25     print(f"Error: {response.status_code}")

Try it

200Retrieved

1 {
2   "collections": [
3     {
4       "collection_id": "col_abc123",
5       "collection_name": "contracts_2024",
6       "environment": "production",
7       "is_active": true,
8       "created_at": "2024-01-15T10:30:00Z",
9       "request_count": 1250
10     }
11   ],
12   "total_count": 1
13 }

List all collections for an organization.

Returns an array of collection objects with collection_name, collection_id, and document_count.

Response

Successful Response

collectionslist of objects

total_countinteger

Headers

Response