Skip to main content

​
Endpoint

GET /accounts
Retrieves a list of all accounts in your Blnk system. Supports pagination and advanced filtering via query parameters.

​
Query Parameters

​
limit
integer
default:"20"
The maximum number of accounts to return per request. Maximum value is typically 100
​
offset
integer
default:"0"
The number of accounts to skip before starting to return results. Used for pagination

​
Advanced Filtering

You can filter accounts using query parameters in the format field_operator=value. Supported operators:
  • eq: Equals
  • ne: Not equals
  • gt: Greater than
  • gte: Greater than or equal
  • lt: Less than
  • lte: Less than or equal
  • in: In array (comma-separated values)
  • like: Pattern matching
  • ilike: Case-insensitive pattern matching
Examples:
  • currency_eq=USD: Get accounts with USD currency
  • currency_in=USD,EUR: Get accounts with USD or EUR currency
  • created_at_gte=2024-01-01: Get accounts created on or after Jan 1, 2024
  • bank_name_ilike=%chase%: Get accounts with “chase” in the bank name

​
Response

Returns an array of account objects.
​
accounts
array
Array of account objects

​
Example Request

# Get first 10 USD accounts
curl -X GET "https://api.blnk.io/accounts?limit=10&currency_eq=USD" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get accounts created in 2024
curl -X GET "https://api.blnk.io/accounts?created_at_gte=2024-01-01&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

[
  {
    "account_id": "acc_789ghi",
    "name": "Main Account",
    "number": "1234567890",
    "bank_name": "Blnk Bank",
    "currency": "USD",
    "balance_id": "bln_321xyz",
    "identity_id": "idt_123abc",
    "ledger_id": "ldg_456def",
    "created_at": "2024-03-04T12:00:00Z",
    "meta_data": {
      "account_type": "savings"
    }
  },
  {
    "account_id": "acc_890jkl",
    "name": "Secondary Account",
    "number": "0987654321",
    "bank_name": "Blnk Bank",
    "currency": "USD",
    "balance_id": "bln_654abc",
    "identity_id": "idt_456def",
    "ledger_id": "ldg_456def",
    "created_at": "2024-03-05T14:30:00Z",
    "meta_data": {
      "account_type": "checking"
    }
  }
]

​
Error Responses

​
error
string
Error message describing what went wrong
​
errors
array
Array of validation errors when using filters

​
Common Errors

  • 400 Bad Request: Invalid query parameters or filter syntax

Build docs developers (and LLMs) love

Get started for freeTalk to us