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

# Lists provider connection status summaries

> List safe provider connection status metadata for the authenticated user's family without exposing credentials, raw provider payloads, or raw sync errors.



## OpenAPI

````yaml /openapi.yaml get /api/v1/provider_connections
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation for the Sure API.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/provider_connections:
    get:
      tags:
        - Provider Connections
      summary: Lists provider connection status summaries
      description: >-
        List safe provider connection status metadata for the authenticated
        user's family without exposing credentials, raw provider payloads, or
        raw sync errors.
      responses:
        '200':
          description: provider connection status summaries listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConnectionCollection'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    ProviderConnectionCollection:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderConnection'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
          nullable: true
        details:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
          nullable: true
    ProviderConnection:
      type: object
      required:
        - id
        - provider
        - provider_type
        - name
        - status
        - requires_update
        - credentials_configured
        - scheduled_for_deletion
        - pending_account_setup
        - institution
        - accounts
        - sync
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        provider:
          type: string
        provider_type:
          type: string
        name:
          type: string
        status:
          type: string
          nullable: true
        requires_update:
          type: boolean
          nullable: true
          description: False when the provider item does not expose this status.
        credentials_configured:
          type: boolean
          nullable: true
          description: False when credential readiness is unknown.
        scheduled_for_deletion:
          type: boolean
          nullable: true
          description: False when the provider item does not expose this status.
        pending_account_setup:
          type: boolean
          nullable: true
          description: False when account setup state is unknown.
        institution:
          $ref: '#/components/schemas/ProviderConnectionInstitution'
        accounts:
          $ref: '#/components/schemas/ProviderConnectionAccounts'
        sync:
          $ref: '#/components/schemas/ProviderConnectionSync'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ProviderConnectionInstitution:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          nullable: true
        domain:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
    ProviderConnectionAccounts:
      type: object
      required:
        - total_count
        - linked_count
        - unlinked_count
      properties:
        total_count:
          type: integer
          minimum: 0
        linked_count:
          type: integer
          minimum: 0
        unlinked_count:
          type: integer
          minimum: 0
    ProviderConnectionSync:
      type: object
      required:
        - syncing
      properties:
        syncing:
          type: boolean
        status_summary:
          type: string
          nullable: true
        last_synced_at:
          type: string
          format: date-time
          nullable: true
        latest:
          allOf:
            - $ref: '#/components/schemas/ProviderConnectionSyncLatest'
          nullable: true
    ProviderConnectionSyncLatest:
      type: object
      required:
        - id
        - status
        - created_at
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
        created_at:
          type: string
          format: date-time
        syncing_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        failed_at:
          type: string
          format: date-time
          nullable: true
        error:
          type: object
          nullable: true
          description: >-
            Sanitized latest sync error summary. Null when the latest sync is
            not failed or stale.
          required:
            - present
          properties:
            present:
              type: boolean
              description: Always true when this object is present.
            message:
              type: string
              nullable: true
              description: >-
                Stable sanitized error category message; raw provider error text
                is never exposed.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````