Skip to main content
GET
/
account_holders
List account holders
curl --request GET \
  --url https://api.ledgerbeam.com/v1/account_holders \
  --header 'API-KEY: <api-key>'
{
  "next_cursor": "XjdHaksD",
  "data": [
    {
      "id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad",
      "type": "consumer",
      "created_at": "2024-03-30T00:00:00Z",
      "name": "John Doe",
      "category_id": "category_id"
    }
  ]
}

​
Overview

Retrieve a list of account holders with optional filtering and pagination. This endpoint allows you to fetch account holders for management and analysis.
  • Account Management: View all account holders in your system
  • Reporting: Generate reports on account holder demographics
  • Integration: Fetch account holders for external systems
  • Analytics: Analyze account holder creation patterns

Authorizations

​
API-KEY
string
header
required

API key for authentication

Query Parameters

​
limit
integer
default:10

Number of account holders to return

Required range: 1 <= x <= 50
​
cursor
string

Pagination cursor

​
created_after
string<date-time>

Filter account holders created after this date

​
created_before
string<date-time>

Filter account holders created before this date

Response

Account holders retrieved successfully

​
next_cursor
string

Pagination cursor for next page

Example:

"XjdHaksD"

​
data
object[]

List of account holders