> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperspell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List connections

> List all connections for the user.



## OpenAPI

````yaml https://app.stainlessapi.com/api/spec/documented/hyperspell.yaml get /connections/list
openapi: 3.1.0
info:
  title: Hyperspell API
  summary: >-
    Hyperspell is the memory layer for AI apps and agents. Through the API, you
    can add memories, connect data sources to index them in real-time, and
    search memories with our natural language query engine.
  termsOfService: https://hyperspell.com/blog/tos
  contact:
    name: Hyperspell
    url: https://hyperspell.com/
    email: hello@hyperspell.com
  version: 0.32.1
servers:
  - url: https://api.hyperspell.com
    description: Production
security:
  - APIKey: []
    AsUser: []
paths:
  /connections/list:
    get:
      tags:
        - Connections
        - Connections
      summary: List connections
      description: List all connections for the user.
      operationId: list_connections_connections_list_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionsResponse'
      security:
        - APIKey: []
        - AsUser: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Hyperspell from '@hyperspell/hyperspell';

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

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

            console.log(connections.connections);
        - lang: Python
          source: |-
            import os
            from hyperspell import Hyperspell

            client = Hyperspell(
                api_key=os.environ.get("HYPERSPELL_API_KEY"),  # This is the default and can be omitted
            )
            connections = client.connections.list()
            print(connections.connections)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/hyperspell/hyperspell-go\"\n\t\"github.com/hyperspell/hyperspell-go/option\"\n)\n\nfunc main() {\n\tclient := hyperspell.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tconnections, err := client.Connections.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", connections.Connections)\n}\n"
        - lang: CLI
          source: |-
            hyperspell connections list \
              --api-key 'My API Key'
components:
  schemas:
    ListConnectionsResponse:
      properties:
        connections:
          items:
            $ref: '#/components/schemas/ConnectionInfo'
          type: array
          title: Connections
      type: object
      required:
        - connections
      title: ListConnectionsResponse
    ConnectionInfo:
      properties:
        id:
          type: string
          title: Id
          description: The connection's id
        integration_id:
          type: string
          title: Integration Id
          description: The connection's integration id
        provider:
          $ref: '#/components/schemas/DocumentProviders'
          description: The connection's provider
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
          description: The connection's label
        selected_count:
          type: integer
          title: Selected Count
          description: >-
            Count of items in user_options.channels (Teams: workspaces selected;
            0 means nothing is being indexed for integrations that require
            selection).
          default: 0
        scope:
          $ref: '#/components/schemas/ConnectionScope'
          description: >-
            'user' for a personal connection; 'app' for an org-wide (app-level)
            connection installed once by an app admin and shared with every user
            of the app.
          default: user
      type: object
      required:
        - id
        - integration_id
        - provider
        - label
      title: ConnectionInfo
    DocumentProviders:
      type: string
      enum:
        - reddit
        - notion
        - slack
        - google_calendar
        - google_mail
        - box
        - dropbox
        - github
        - google_drive
        - vault
        - web_crawler
        - trace
        - microsoft_teams
        - gmail_actions
        - granola
        - fathom
        - fireflies
        - linear
        - hubspot
        - salesforce
        - coda
        - lightfield
        - gong
        - pylon
        - clickup
      title: DocumentProviders
    ConnectionScope:
      type: string
      enum:
        - user
        - app
      title: ConnectionScope
      description: >-
        Who owns a connection (ENG-2556,
        specs/flows/shared-and-app-level-ingestion.md).


        ``user`` — today's per-user connection: one Hyperspell user, their
        token.

        ``app`` — an app-level (bot-token) connection owned by the app as a
        whole; its

        ``user_id`` is the reserved deterministic bot principal

        (:func:`hyperspell_core.lib.bot_principal.bot_principal`), never a real
        user id.
  securitySchemes:
    APIKey:
      type: http
      description: >-
        API Key or JWT User Token. If using an API Key, set the X-As-User header
        to act as a specific user. A JWT User Token is always scoped to a
        specific user.
      scheme: bearer
      bearerFormat: Bearer <token>
    AsUser:
      type: apiKey
      description: >-
        Optionally set this header to act as a specific user when using an API
        Key, equivalent to first exchanging the API Key for a User Token
      in: header
      name: X-As-User

````