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

# List consented connections for structured reads

> Requires financial_data:read and CONNECT_STRUCTURED_READS. Provider capability metadata does not check current bank health or configured runtime tools.



## OpenAPI

````yaml /api-reference/openapi.yaml get /connect/data/connections
openapi: 3.0.3
info:
  title: Payman Connect API
  version: 0.1.0
  description: >-
    The HTTP contract behind Payman Connect: exchange a customer's consent for a
    grant, send actions against the accounts it reaches, and follow an approval
    to its receipt. Every call carries your app key, and every call after the
    exchange carries the grant. Non-2xx responses share one `ApiError` envelope.
    Most integrations never write these calls: the SDK speaks them for you.
servers:
  - url: https://paygent-cloud-server-production.up.railway.app
    description: Current hosted Railway deployment
  - url: http://localhost:8891
    description: A local stack
security:
  - bearerAuth: []
tags:
  - name: Connect
    description: >-
      Third-party access. A registered app presents its app key together with a
      grant token its customer consented to; the pair reaches exactly the one
      deployment the grant names, and nothing else on this API.
paths:
  /connect/data/connections:
    get:
      tags:
        - Connect
      summary: List consented connections for structured reads
      description: >-
        Requires financial_data:read and CONNECT_STRUCTURED_READS. Provider
        capability metadata does not check current bank health or configured
        runtime tools.
      operationId: listFinancialDataConnections
      responses:
        '200':
          description: Connection IDs, labels, providers, status, and native sync support.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          description: Invalid or expired Connect credentials
        '403':
          description: financial_data:read scope is absent
      security:
        - connectAppKey: []
          connectGrant: []
        - connectGrant: []
components:
  securitySchemes:
    connectAppKey:
      type: apiKey
      in: header
      name: x-paygent-connect-app-key
      description: >-
        A Connect app key (`pgc_app_…`), identifying the registered third-party
        app. Always presented together with `connectGrant` — the pair is one
        credential, and either half alone is refused. Accepted on the
        `/connect/*` surface only.
    connectGrant:
      type: apiKey
      in: header
      name: x-paygent-connect-grant
      description: >-
        A Connect grant token (`pgc_grant_…`): one user's consent for the
        presenting app to reach one deployment. Every failure mode — missing,
        malformed, revoked, expired, or paired with the wrong app key — answers
        the same 401 `invalid_connect_credentials`.

````

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