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

# Read a connection



## OpenAPI

````yaml /partner-openapi.gen.json get /partner/connections/{connectionId}
openapi: 3.1.0
info:
  title: Circuit partner API
  version: '0.1'
servers:
  - url: https://api.circuit.org
security: []
paths:
  /partner/connections/{connectionId}:
    get:
      summary: Read a connection
      operationId: readConnection
      parameters:
        - name: circuit-partner-version
          in: header
          required: true
          example: '0.1'
          schema:
            type: string
            const: '0.1'
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sealedPermit:
                    description: >-
                      The permit sealed to your key; null until the user
                      approves, then until `expiresAt`.
                    type:
                      - string
                      - 'null'
                  retryAfterMs:
                    type:
                      - integer
                      - 'null'
                    format: uint64
                    minimum: 0
        default:
          description: Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerFailure'
      security: []
components:
  schemas:
    PartnerFailure:
      description: 'A failed call: act on its HTTP status and show `error` to the user.'
      type: object
      properties:
        error:
          type: string
      required:
        - error

````

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