Skip to main content
GET
/
v1
/
source-connections
/
{id}
Get Source Connection
curl --request GET \
  --url https://api.example.com/v1/source-connections/{id}
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "short_name": "<string>",
  "readable_collection_id": "<string>",
  "status": "<string>",
  "auth": {
    "method": "<string>",
    "authenticated": true,
    "authenticated_at": "<string>",
    "expires_at": "<string>",
    "auth_url": "<string>"
  },
  "config": {},
  "schedule": {
    "cron": "<string>",
    "next_run": "<string>",
    "continuous": true
  },
  "sync": {
    "total_runs": 123,
    "successful_runs": 123,
    "failed_runs": 123,
    "last_job": {}
  },
  "entities": {
    "total_entities": 123,
    "by_type": {}
  }
}

​
Overview

Retrieve complete information about a source connection including:
  • Configuration settings
  • Authentication status
  • Sync schedule and history
  • Entity statistics

​
Path Parameters

​
id
string
required
Unique UUID identifier of the source connectionExample: “550e8400-e29b-41d4-a716-446655440000”

​
Response

​
id
string
required
Unique UUID identifier
​
organization_id
string
required
Organization this connection belongs to
​
name
string
required
Display name of the connection
​
description
string
Optional description of the connection’s purpose
​
short_name
string
required
Source type identifier (e.g., “github”, “slack”)
​
readable_collection_id
string
required
Collection this connection belongs to
​
status
string
required
Current operational status
​
auth
object
required
Authentication status and details
​
config
object
Source-specific configuration values
​
schedule
object
Sync schedule configuration
​
sync
object
Sync execution history and statistics
​
entities
object
Summary of synced entities

​
Example Request

curl https://api.airweave.ai/v1/source-connections/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GitHub Docs Repo",
  "description": "Main documentation repository",
  "short_name": "github",
  "readable_collection_id": "documentation-ab123",
  "status": "ACTIVE",
  "created_at": "2024-03-15T09:30:00Z",
  "modified_at": "2024-03-15T14:22:15Z",
  "auth": {
    "method": "direct",
    "authenticated": true,
    "authenticated_at": "2024-03-15T09:30:00Z"
  },
  "config": {
    "repo_name": "company/docs",
    "branch": "main"
  },
  "schedule": {
    "cron": "0 */6 * * *",
    "next_run": "2024-03-15T18:00:00Z"
  },
  "sync": {
    "total_runs": 15,
    "successful_runs": 14,
    "failed_runs": 1,
    "last_job": {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "status": "COMPLETED",
      "started_at": "2024-03-15T12:00:00Z",
      "completed_at": "2024-03-15T12:05:32Z",
      "duration_seconds": 332,
      "entities_inserted": 45,
      "entities_updated": 12
    }
  },
  "entities": {
    "total_entities": 1250,
    "by_type": {
      "file": {"count": 1250}
    }
  },
  "federated_search": false
}

​
Error Responses

​
404 Not Found
Source connection with the specified ID does not exist