Skip to content
Get started

List connections

connections.list(ConnectionListParams**kwargs) -> ConnectionListResponse
POST/v3/connections/list

List all connections

ParametersExpand Collapse
container_tags: Optional[Sequence[str]]

Optional comma-separated list of container tags to filter documents by

ReturnsExpand Collapse
List[ConnectionListResponseItem]
id: str
created_at: str
formatdatetime
provider: str
Deprecatedcontainer_tags: Optional[List[str]]
document_limit: Optional[float]
email: Optional[str]
expires_at: Optional[str]
formatdatetime
last_sync_run: Optional[ConnectionListResponseItemLastSyncRun]
status: str
completed_at: Optional[str]
formatdatetime
error: Optional[str]
error_code: Optional[Literal["auth_expired", "rate_limited", "plan_required", 2 more]]
One of the following:
"auth_expired"
"rate_limited"
"plan_required"
"provider_unavailable"
"internal"
started_at: Optional[str]
formatdatetime
metadata: Optional[Dict[str, object]]

List connections

import os
from supermemory import Supermemory

client = Supermemory(
    api_key=os.environ.get("SUPERMEMORY_API_KEY"),  # This is the default and can be omitted
)
connections = client.connections.list()
print(connections)
[
  {
    "id": "id",
    "createdAt": "createdAt",
    "provider": "provider",
    "containerTags": [
      "string"
    ],
    "documentLimit": 0,
    "email": "email",
    "expiresAt": "expiresAt",
    "lastSyncRun": {
      "status": "status",
      "completedAt": "completedAt",
      "error": "error",
      "errorCode": "auth_expired",
      "startedAt": "startedAt"
    },
    "metadata": {
      "foo": "bar"
    }
  }
]
Returns Examples
[
  {
    "id": "id",
    "createdAt": "createdAt",
    "provider": "provider",
    "containerTags": [
      "string"
    ],
    "documentLimit": 0,
    "email": "email",
    "expiresAt": "expiresAt",
    "lastSyncRun": {
      "status": "status",
      "completedAt": "completedAt",
      "error": "error",
      "errorCode": "auth_expired",
      "startedAt": "startedAt"
    },
    "metadata": {
      "foo": "bar"
    }
  }
]