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

# List connections

> Returns a cursor page of safe connection metadata. Credential material is never returned. When status is omitted, revoked tombstones are excluded; pass status=revoked to retrieve them explicitly.



## OpenAPI

````yaml /openapi/platform.v1.json get /v1/connections
openapi: 3.0.3
info:
  description: Public platform API for catalog and proxied data-plane routes.
  title: Matrices Platform API
  version: v1
servers:
  - url: https://api.matrices.com
security: []
tags:
  - description: Authenticated bearer credential context.
    name: auth
    x-group: Auth
  - description: Write-only provider credentials with safe connection metadata.
    name: connections
    x-group: Connections
  - description: Materialized workspace principals and active agent counts.
    name: identities
    x-group: Identities
  - description: Remote MCP server registrations.
    name: toolsets
    x-group: Toolsets
  - description: Named allow-only agent tool permissions.
    name: roles
    x-group: Roles
  - description: Client-executed tool calls.
    name: tools
    x-group: Tools
  - description: Reusable agent behavior profiles.
    name: profiles
    x-group: Profiles
  - description: Workspace-owned agent identities.
    name: agents
    x-group: Agents
  - description: Immutable private image inputs.
    name: images
    x-group: Images
  - description: Public model catalog.
    name: models
    x-group: Models
  - description: Running agent threads.
    name: threads
    x-group: Threads
  - description: Agent schedules.
    name: schedules
    x-group: Schedules
  - description: Workspace append-only feeds.
    name: feeds
    x-group: Feeds
  - description: Agent subscriptions over workspace feeds.
    name: subscriptions
    x-group: Subscriptions
  - description: Agent-private and workspace-shared durable memory notes.
    name: memory
    x-group: Memory
  - description: Thread messages.
    name: messages
    x-group: Messages
  - description: Thread event log data.
    name: events
    x-group: Events
  - description: Runtime hook audit and wait resolution.
    name: hooks
    x-group: Hooks
paths:
  /v1/connections:
    get:
      tags:
        - connections
      summary: List connections
      description: >-
        Returns a cursor page of safe connection metadata. Credential material
        is never returned. When status is omitted, revoked tombstones are
        excluded; pass status=revoked to retrieve them explicitly.
      operationId: ListConnections
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
        - in: query
          name: provider
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/AuthProvider'
            description: >-
              Return only connections to this managed provider. Mutually
              exclusive with toolsetId — a connection belongs to either a
              managed provider or a custom toolset.
        - in: query
          name: toolsetId
          required: false
          schema:
            description: >-
              Return only connections to this custom toolset. Mutually exclusive
              with provider — a connection belongs to either a managed provider
              or a custom toolset.
            maxLength: 24
            pattern: ^toolset_[0-9a-f]{16}$
            type: string
        - in: query
          name: ownerType
          required: false
          schema:
            $ref: '#/components/schemas/ConnectionOwnerType'
        - description: >-
            Return one exact status. When omitted, revoked tombstones are
            excluded.
          in: query
          name: status
          required: false
          schema:
            $ref: '#/components/schemas/ConnectionStatus'
        - in: query
          name: identity
          required: false
          schema:
            description: >-
              Return only connections owned by exactly this identity (implies
              ownerType=identity).
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionPage'
          description: Connection page.
        '202':
          $ref: '#/components/responses/PendingOperation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '503':
          $ref: '#/components/responses/CatalogUnavailable'
      security:
        - APIKeyBearer: []
        - AgentLeaseBearer: []
components:
  parameters:
    Limit:
      in: query
      name: limit
      required: false
      schema:
        maximum: 200
        minimum: 1
        type: integer
    Cursor:
      in: query
      name: cursor
      required: false
      schema:
        type: string
  schemas:
    AuthProvider:
      enum:
        - google
        - slack
        - notion
        - github
        - linear
        - vercel
        - figma
        - stripe
        - posthog
        - datadog
        - cloudflare
        - apollo
      type: string
    ConnectionOwnerType:
      enum:
        - workspace
        - identity
      type: string
    ConnectionStatus:
      enum:
        - ready
        - needs_reauth
        - revoked
      type: string
    ConnectionPage:
      properties:
        connections:
          items:
            $ref: '#/components/schemas/Connection'
          type: array
        nextCursor:
          type: string
      required:
        - connections
      type: object
    Connection:
      description: Safe connection metadata. Credential material is never returned.
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        kind:
          $ref: '#/components/schemas/ConnectionKind'
        name:
          type: string
        namespace:
          type: string
        owner:
          $ref: '#/components/schemas/ConnectionOwner'
        products:
          items:
            $ref: '#/components/schemas/ConnectionProduct'
          type: array
        provider:
          $ref: '#/components/schemas/AuthProvider'
        remoteResource:
          $ref: '#/components/schemas/ConnectionResource'
        remoteSubject:
          type: string
        remoteTenant:
          type: string
        revokedAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/ConnectionStatus'
        updatedAt:
          format: date-time
          type: string
        version:
          format: int64
          minimum: 1
          type: integer
        workspaceId:
          type: string
      required:
        - id
        - workspaceId
        - kind
        - name
        - owner
        - status
        - version
        - createdAt
        - updatedAt
      type: object
    OperationResponse:
      additionalProperties: false
      properties:
        operation:
          $ref: '#/components/schemas/Operation'
      required:
        - operation
      type: object
    ErrorResponse:
      properties:
        attemptsRemaining:
          type: integer
        code:
          type: string
        error:
          type: string
        message:
          type: string
        retryAfterSeconds:
          type: integer
      required:
        - error
        - message
      type: object
    ConnectionKind:
      description: Credential shape held by a connection.
      enum:
        - token
        - oauth
      type: string
    ConnectionOwner:
      discriminator:
        mapping:
          identity: '#/components/schemas/IdentityConnectionOwner'
          workspace: '#/components/schemas/WorkspaceConnectionOwner'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/WorkspaceConnectionOwner'
        - $ref: '#/components/schemas/IdentityConnectionOwner'
    ConnectionProduct:
      additionalProperties: false
      properties:
        namespace:
          type: string
        presets:
          items:
            $ref: '#/components/schemas/ProviderAccessPreset'
          type: array
      required:
        - namespace
        - presets
      type: object
    ConnectionResource:
      additionalProperties: false
      properties:
        id:
          type: string
        kind:
          $ref: '#/components/schemas/ConnectionResourceKind'
        name:
          type: string
      required:
        - kind
        - id
        - name
      type: object
    Operation:
      additionalProperties: false
      properties:
        action:
          type: string
        agentId:
          type: string
        createdAt:
          format: date-time
          type: string
        expiresAt:
          format: date-time
          type: string
        id:
          type: string
        resolvedAt:
          format: date-time
          type: string
        resolvedBy:
          $ref: '#/components/schemas/Principal'
        result:
          $ref: '#/components/schemas/OperationResult'
        state:
          $ref: '#/components/schemas/OperationState'
      required:
        - id
        - agentId
        - action
        - state
        - createdAt
        - expiresAt
      type: object
    IdentityConnectionOwner:
      additionalProperties: false
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        type:
          enum:
            - identity
          type: string
      required:
        - type
        - identity
      type: object
    WorkspaceConnectionOwner:
      additionalProperties: false
      properties:
        type:
          enum:
            - workspace
          type: string
      required:
        - type
      type: object
    ProviderAccessPreset:
      enum:
        - default
        - read_only
        - full
      type: string
    ConnectionResourceKind:
      enum:
        - workspace
        - project
      type: string
    Principal:
      properties:
        id:
          type: string
        identity:
          $ref: '#/components/schemas/Identity'
        origin:
          $ref: '#/components/schemas/Origin'
        type:
          enum:
            - user
            - api_key
            - agent
            - schedule
            - trigger
            - subscription
          type: string
      required:
        - type
        - id
      type: object
    OperationResult:
      additionalProperties: false
      properties:
        body: {}
        status:
          maximum: 599
          minimum: 100
          type: integer
      required:
        - status
      type: object
    OperationState:
      enum:
        - pending
        - denied
        - expired
        - executing
        - executed
        - failed
      type: string
    Identity:
      description: >-
        Provenance identity. Surrounding whitespace is trimmed on input; values
        may contain at most 512 UTF-8 bytes and no Unicode control characters.
      type: string
    Origin:
      additionalProperties: false
      description: >-
        Caller-asserted external event metadata. Only trigger principals may
        assert it; every other principal is rejected.
      properties:
        channelId:
          description: Provider channel identifier, limited to 512 UTF-8 bytes.
          type: string
        messageId:
          description: Provider message identifier, limited to 512 UTF-8 bytes.
          type: string
        provider:
          $ref: '#/components/schemas/OriginProvider'
        senderId:
          description: Provider sender identifier, limited to 512 UTF-8 bytes.
          type: string
        tenantId:
          description: Provider tenant identifier, limited to 512 UTF-8 bytes.
          type: string
        threadId:
          description: Provider thread identifier, limited to 512 UTF-8 bytes.
          type: string
      required:
        - provider
        - tenantId
        - senderId
      type: object
    OriginProvider:
      description: >-
        Caller-asserted external event provider. This value carries no
        authority.
      enum:
        - slack
      type: string
  responses:
    PendingOperation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OperationResponse'
      description: >-
        Request parked for workspace approval. Poll the returned operation
        handle for a terminal result.
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Invalid request.
    CatalogUnavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Platform catalog database is not configured or unavailable.
  securitySchemes:
    APIKeyBearer:
      scheme: bearer
      type: http
    AgentLeaseBearer:
      description: >-
        Short-lived agent lease bearer installed in a sandbox provider HTTP
        boundary. Requests run as the owning agent and are checked against live
        agent permissions.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.