--- updatedAt: 2026-05-27T08:29:42.000Z agentTools: projectIndex: https://docs.bridgeapi.io/llms.txt --- # List accounts Return a list of the user's accounts # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Bridge API", "version": "2025-01-15", "description": "Bridge provides an Open Banking API to initiate payments and aggregate financial data. \nOur API uses standards such as HTTP verbs, RESTful routing and JSON for payloads.", "license": { "name": "Proprietary", "url": "https://docs.bridgeapi.io" }, "contact": { "name": "BridgeAPI", "url": "https://bridgeapi.io", "email": "support@bridgeapi.io" } }, "servers": [ { "description": "Production", "url": "https://api.bridgeapi.io" } ], "tags": [ { "name": "Accounts", "description": "Accounts are tied to items and represent financial accounts, such as checking accounts" } ], "paths": { "/v3/aggregation/accounts": { "summary": "Accounts", "description": "Operations on accounts.", "parameters": [ { "$ref": "#/components/parameters/version" } ], "get": { "tags": [ "Accounts" ], "operationId": "GetAccounts", "summary": "List accounts", "description": "Return a list of the user's accounts", "security": [ { "userTokenBearerAuth": [], "clientIdAuth": [], "clientSecretAuth": [] } ], "parameters": [ { "name": "limit", "description": "Number of records to return", "in": "query", "schema": { "type": "number", "default": 50, "minimum": 1, "maximum": 500 } }, { "name": "item_id", "description": "Filter accounts by item", "in": "query", "schema": { "type": "number", "example": 9465465 } } ], "responses": { "200": { "description": "List accounts", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/account" } } } }, { "$ref": "#/components/schemas/paginated-result" } ] }, "example": { "resources": [ { "id": 48178048, "name": "Compte Courant 1", "balance": 1489.54, "accounting_balance": 1489.54, "instant_balance": 1463.89, "updated_at": "2024-11-20T16:10:09.429Z", "last_refresh_status": "failed", "type": "checking", "currency_code": "EUR", "item_id": 10154848, "provider_id": 574, "data_access": "enabled", "pro": false, "iban": "FR6914508000303386763591H62" }, { "id": 48152385, "name": "Crédit Immo", "balance": 427928, "updated_at": "2024-11-19T16:15:56.670Z", "last_refresh_status": "successful", "type": "loan", "currency_code": "EUR", "item_id": 10149741, "provider_id": 574, "loan_details": { "next_payment_date": "2024-12-01", "next_payment_amount": 2772, "maturity_date": "2041-12-01", "opening_date": "2021-01-01", "interest_rate": 2.42, "borrowed_capital": 500000, "repaid_capital": 72072, "remaining_capital": 427928, "total_estimated_interests": 107947.56252904824 }, "data_access": "enabled", "pro": false }, { "id": 48152384, "name": "Livret A", "balance": 496, "updated_at": "2024-11-19T16:15:56.653Z", "last_refresh_status": "successful", "type": "savings", "currency_code": "EUR", "item_id": 10149741, "provider_id": 574, "data_access": "enabled", "pro": false } ], "generated_at": "2024-11-21T16:35:16.846Z", "pagination": { "next_uri": "/v3/aggregation/accounts?after=NDgxNTE3OTg&limit=50" } } } } }, "401": { "description": "Error 401", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-401" } } } } } } } }, "components": { "schemas": { "error-401": { "title": "Error 401", "type": "object", "example": { "errors": [ { "code": "invalid_client_credentials", "message": "client_id and client_secret are invalid" } ] }, "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "description": "Error code", "type": "string" }, "property": { "description": "Property or parameter that is invalid", "type": [ "null", "string" ] }, "message": { "description": "Human-readable error description", "type": [ "null", "string" ] } } } } } }, "paginated-result": { "title": "Pagination response", "description": "Represent paginated collection of resources.", "type": "object", "properties": { "resources": { "type": "array", "items": {} }, "pagination": { "type": "object", "properties": { "next_uri": { "type": [ "null", "string" ], "example": null } } } } }, "account": { "title": "Account resource", "description": "An account represents current state of a bank account.", "type": "object", "properties": { "id": { "description": "Account's unique identifier", "type": "number", "example": 2341501 }, "name": { "description": "Account's name taken from the provider's website", "type": "string", "example": "Compte Crédit Immobilier" }, "balance": { "description": "Account's balance", "type": "number", "example": -140200.46 }, "accounting_balance": { "description": "Accounting balance represents the available money excluding pending and processing transactions", "type": "number", "example": -140200.46 }, "instant_balance": { "description": "Instant balance represents the expected money on the account including pending and processing transactions", "type": "number", "example": -140200.46 }, "updated_at": { "description": "Timestamp recording when the account was last updated", "type": "string", "format": "date-time", "example": "2024-10-16T07:59:11.785Z" }, "last_refresh_status": { "description": "Indicate if the account was updated successfully or not during the last refresh of the item", "type": "string", "enum": [ "failed", "successful" ], "example": "successful" }, "type": { "description": "Account's type", "type": "string", "enum": [ "checking", "savings", "brokerage", "card", "loan", "pea", "life_insurance", "unknown" ], "example": "loan" }, "currency_code": { "description": "3 letters ISO 4217 currency code", "type": "string", "example": "EUR" }, "item_id": { "description": "Identifier of the account's item", "type": "number", "example": 123456789 }, "provider_id": { "description": "Identifier of the account's provider", "type": "number", "example": 574 }, "loan_details": { "type": "object", "properties": { "next_payment_date": { "description": "Date when the next payment is owed", "type": "string", "format": "date", "example": "2024-12-01" }, "next_payment_amount": { "description": "Amount owed for the next payment", "type": "number", "example": 1000 }, "maturity_date": { "description": "Predicted end of the loan's refunding", "type": "string", "format": "date", "example": "2035-04-30" }, "opening_date": { "description": "Date when the loan was contracted", "type": "string", "format": "date", "example": "2024-11-01" }, "interest_rate": { "description": "Loan's interest rate", "type": "number", "example": 1.25 }, "type": { "description": "Loan type", "type": "string", "example": "mortgage" }, "borrowed_capital": { "description": "Amount of capital that was borrowed", "type": "number", "example": 140200 }, "repaid_capital": { "description": "Amount of capital that has already been repaid.", "type": "number", "example": 40200 }, "remaining_capital": { "description": "Amount of capital left to repay", "type": "number", "example": 100000 } } }, "pro": { "description": "Flag to indicate that the account is a business account", "type": "boolean", "example": "false" }, "data_access": { "description": "User approved access to this account", "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "iban": { "description": "The IBAN of the bank account", "type": "string", "format": "iban", "example": "FR2420020202260600024M02606" } } } }, "parameters": { "version": { "in": "header", "name": "Bridge-Version", "schema": { "type": "string", "enum": [ "2025-01-15" ], "default": "2025-01-15" }, "required": true, "description": "The Bridge API version" } }, "securitySchemes": { "userTokenBearerAuth": { "type": "http", "scheme": "bearer", "description": "Aggregation user access token" }, "clientIdAuth": { "type": "apiKey", "in": "header", "name": "Client-Id" }, "clientSecretAuth": { "type": "apiKey", "in": "header", "name": "Client-Secret" } } }, "security": [ { "clientIdAuth": [], "clientSecretAuth": [] } ], "x-readme": { "explorer-enabled": false, "proxy-enabled": false } } ```