List connections

client.connections.list(, ?): ConnectionListResponse { id, createdAt, provider, 6 more }

POST/v3/connections/list

List all connections

ParametersExpand Collapse

body: ConnectionListParams { containerTags }

containerTags?: Array<string>

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

ReturnsExpand Collapse

ConnectionListResponse = Array<ConnectionListResponseItem>

id: string

createdAt: string

formatdatetime

provider: string

DeprecatedcontainerTags?: Array<string>

documentLimit?: number

email?: string

expiresAt?: string

formatdatetime

lastSyncRun?: LastSyncRun { status, completedAt, error, 2 more }

status: string

completedAt?: string

formatdatetime

error?: string | null

errorCode?: "auth_expired" | "rate_limited" | "plan_required" | 2 more | null

One of the following:

"auth_expired"

"rate_limited"

"plan_required"

"provider_unavailable"

"internal"

startedAt?: string

formatdatetime

metadata?: Record<string, unknown>

List connections

import Supermemory from 'supermemory';

const client = new Supermemory({
  apiKey: process.env['SUPERMEMORY_API_KEY'], // This is the default and can be omitted
});

const connections = await client.connections.list();

console.log(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"
    }
  }
]