Skip to main content
GET
/
accounts
List accounts
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "acc_FINICITY_45",
      "iso_currency_code": "USD",
      "connection_id": "con_FINICITY_41294",
      "client_id": "<string>",
      "name": "<string>",
      "mask": "1234",
      "current_balance": 1234.56,
      "available_balance": 123,
      "last_refreshed_at": "2023-11-07T05:31:56Z",
      "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"
              }
            ]
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "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.

Query Parameters

​
client_id
string
required

The Client (cli_…) to scope the read to. Required on account, transaction, and statement reads — LedgerSync's backend data APIs are scoped per end-user, so these resources are resolved within a single Client.

​
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
​
connection_id
string

Only return Accounts surfaced by this Connection. Must be the canonical id (con_<SOURCE>_<bankAccountId>, e.g. con_FINICITY_41294); the placeholder UUID returned during initiate is rejected with 400.

Example:

"con_FINICITY_41294"

​
source
enum<string>

Only return Accounts from this aggregation source. 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

Response

OK

​
data
object[]
required