Skip to main content
GET
/
v1
/
source-connections
List Source Connections
curl --request GET \
  --url https://api.example.com/v1/source-connections
{
  "id": "<string>",
  "name": "<string>",
  "short_name": "<string>",
  "readable_collection_id": "<string>",
  "is_authenticated": true,
  "entity_count": 123,
  "auth_method": "<string>",
  "status": "<string>",
  "created_at": "<string>",
  "modified_at": "<string>",
  "federated_search": true
}

​
Overview

Retrieve all source connections in your organization. Returns a lightweight list with essential fields for display and navigation. For full connection details including sync history, use the GET / endpoint.

​
Query Parameters

​
collection
string
Filter by collection readable IDExample: “customer-support-tickets-x7k9m”
​
skip
integer
default:0
Number of connections to skip for pagination (minimum: 0)
​
limit
integer
default:100
Maximum number of connections to return (1-1000)

​
Response

Returns an array of source connection objects.
​
id
string
required
Unique UUID identifier of the source connection
​
name
string
required
Display name of the connection
​
short_name
string
required
Source type identifier (e.g., “github”, “slack”)
​
readable_collection_id
string
required
Collection this connection belongs to
​
is_authenticated
boolean
required
Whether the connection has valid credentials
​
entity_count
integer
required
Total number of entities synced from this connection
​
auth_method
string
required
Authentication method: direct, oauth_browser, oauth_token, oauth_byoc, or auth_provider
​
status
string
required
Current status: PENDING_AUTH, ACTIVE, SYNCING, INACTIVE, or ERROR
​
created_at
string
required
ISO 8601 timestamp when created
​
modified_at
string
required
ISO 8601 timestamp when last modified
​
federated_search
boolean
required
Whether this source uses federated (real-time) search

​
Example Request

curl "https://api.airweave.ai/v1/source-connections?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "GitHub Docs Repo",
    "short_name": "github",
    "readable_collection_id": "documentation-ab123",
    "created_at": "2024-03-15T09:30:00Z",
    "modified_at": "2024-03-15T14:22:15Z",
    "is_authenticated": true,
    "entity_count": 1250,
    "federated_search": false,
    "auth_method": "direct",
    "status": "ACTIVE"
  }
]