AIairweave-ai
source-connections

List Source Connections

Changed on

Retrieve all source connections for your organization.

Returns a lightweight list of source connections with essential fields for display and navigation. Use the collection filter to see connections within a specific collection.

For full connection details including sync history, use the GET /{id} endpoint.

get/source-connections

Request

  • Base URL
    https://api.airweave.ai
  • Auth
    API key in header x-api-key

Query parameters

collectionstring nullable

Filter by collection readable ID

Example:customer-support-tickets-x7k9m
skipinteger

Number of connections to skip for pagination

limitinteger

Maximum number of connections to return (1-1000)

Example:100

Response

List of source connections

idstring uuid required

Unique identifier of the source connection

namestring required

Display name of the connection

short_namestring required

Source type identifier

readable_collection_idstring required

Collection this connection belongs to

created_atstring date-time required

When the connection was created (ISO 8601)

modified_atstring date-time required

When the connection was last modified (ISO 8601)

is_authenticatedboolean required

Whether the connection has valid credentials

entity_countinteger

Total number of entities synced from this connection

federated_searchboolean

Whether this source uses federated (real-time) search instead of syncing

auth_method'direct' | 'oauth_browser' | 'oauth_token' | 'oauth_byoc' | 'auth_provider' required

Authentication methods for source connections.

status'active' | 'pending_auth' | 'syncing' | 'error' | 'inactive' | 'pending_sync' required

Source connection status enum - represents overall connection state.

Example response

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

Changes

  • 9c8b36d8fcaaRevision changes
    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      response property detail/items/loc/items/ list-of-types was narrowed by removing types integer from media type application/json of response 422

  • c25c4670614eRevision changes
    • info

      added the optional property / to the response with the status