Skip to main content
GET
/
clients
/
{client_id}
/
connections
List a client's connections
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients/{client_id}/connections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "con_FINICITY_41294",
      "client_id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
      "created_at": "2023-11-07T05:31:56Z",
      "institution": {
        "id": "<string>",
        "name": "Chase",
        "logo_url": "<string>"
      },
      "last_refreshed_at": "2023-11-07T05:31:56Z",
      "last_error": {
        "code": "unknown_api_key",
        "message": "The API key you presented doesn't match any active key.",
        "type": "auth_error",
        "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
        "category": "AUTH_ERROR",
        "is_user_actionable": true,
        "source_diagnostic_code": "FIN-103",
        "param": "client.email",
        "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
        "errors": [
          {
            "param": "client.email",
            "message": "must be a valid email address",
            "code": "invalid_email"
          }
        ]
      },
      "expected_capabilities": {
        "transactions": {},
        "balance": {},
        "available_balance": {},
        "statements": {},
        "check_images": {}
      },
      "realized_capabilities": {
        "transactions": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "balance": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "available_balance": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "statements": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        },
        "check_images": {
          "last_success_at": "2023-11-07T05:31:56Z",
          "next_refresh_after": "2023-11-07T05:31:56Z",
          "last_error": {
            "code": "unknown_api_key",
            "message": "The API key you presented doesn't match any active key.",
            "type": "auth_error",
            "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
            "category": "AUTH_ERROR",
            "is_user_actionable": true,
            "source_diagnostic_code": "FIN-103",
            "param": "client.email",
            "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
            "errors": [
              {
                "param": "client.email",
                "message": "must be a valid email address",
                "code": "invalid_email"
              }
            ]
          }
        }
      },
      "_debug": {
        "source_used": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

​
client_id
string
required

Query Parameters

​
cursor
string

Opaque cursor returned by a previous list response.

​
limit
integer
default:25

Max items per page (1–100).

Required range: 1 <= x <= 100
​
source
enum<string>

Filter to one source — useful when your app handles multiple aggregators. Financial-data source backing a connection. All sources wrap upstream aggregators or extraction pipelines.

Values:

  • FINICITY — Finicity aggregation
  • MX — MX aggregation
  • FDE — Financial Document Extraction (LedgerSync proprietary)
Available options:
FINICITY,
MX,
FDE
​
status
enum<string>

Filter by lifecycle status — e.g. requires_action to find the connections needing user input. Connection lifecycle status.

  • initiated — Connection started, waiting for end-user or upstream to complete
  • requires_action — Awaiting MFA or reauthorization from the end-user
  • active — Healthy, refreshing on schedule
  • failed — Connection failed; review last_error
  • disconnected — End-user revoked or LedgerSync disconnected
Available options:
initiated,
requires_action,
active,
failed,
disconnected

Response

A page of Connections.

​
data
object[]
required