List Syncs

GET

https://api.captain.dev/v2/syncs

GET

/v2/syncs

1 import requests
2 
3 BASE_URL = "https://api.captain.dev"
4 API_KEY = "your_api_key"
5 
6 headers = {
7     "Authorization": f"Bearer {API_KEY}",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(
12     f"{BASE_URL}/v2/syncs",
13     headers=headers
14 )
15 
16 print(response.json())

200Retrieved

1 {
2   "connections": [
3     {
4       "sync_id": "sync_7e0abee6e110457db2c8",
5       "collection_name": "company-knowledge",
6       "bucket": "my-company-docs",
7       "prefix": "knowledge-base/",
8       "region": "us-east-1",
9       "storage_type": "s3",
10       "auth_method": "iam_role",
11       "endpoint_url": null,
12       "processing_type": "advanced",
13       "include_patterns": [],
14       "exclude_patterns": [],
15       "deletion_policy": "mirror",
16       "status": "active",
17       "secret_set": false,
18       "sns_subscribe_url": null,
19       "last_backfill_job_id": "91f2aa031d8f4e7d8877c4564eb486bd-1786120498",
20       "last_reconcile_at": null,
21       "sync_interval_minutes": 15,
22       "next_sync_at": 1786120589056,
23       "sync_state": "idle",
24       "last_sync_at": null,
25       "last_sync_error": null,
26       "created_at": "2026-08-07T16:34:58.188233+00:00",
27       "updated_at": "2026-08-07T16:34:58.612676+00:00"
28     }
29   ]
30 }

List your organization’s syncs across all storage providers. Deleted syncs are excluded; paused syncs are included.

Response

Successful Response

connectionslist of objectsOptional

Headers

Response