Accounts

List accounts

Fetch a list of accounts associated with your organization.

The List Accounts endpoint returns a paginated list of all accounts. This endpoint is typically restricted to administrators or platform-level integrations that need to manage multiple accounts.

Endpoint

GET /v1/accounts

Headers

Key	Value	Required
Authorization	Bearer <admin_token>	Yes

Query Parameters

Parameter	Type	Required	Description
page	int	No	Page number for pagination (default: 1).
limit	int	No	Number of results per page (default: 25, max: 100).
status	string	No	Filter accounts by status (active, suspended, closed).
type	string	No	Filter accounts by type (individual, business).
created_after	string	No	Return accounts created after a specific ISO 8601 timestamp.
created_before	string	No	Return accounts created before a specific ISO 8601 timestamp.

Response

Successful Response (200 OK)

{
  "data": [
    {
      "id": "acct_001",
      "email": "owner@example.com",
      "name": "Acme Inc.",
      "type": "business",
      "status": "active",
      "created_at": "2024-05-12T09:30:00Z",
      "updated_at": "2025-09-18T20:20:00Z"
    },
    {
      "id": "acct_002",
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "type": "individual",
      "status": "suspended",
      "created_at": "2024-07-01T12:45:00Z",
      "updated_at": "2025-09-15T14:10:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 2,
    "has_next": false
  }
}

Field	Type	Description
data	array	Array of account objects.
pagination	object	Metadata about the current page of results.
page	int	Current page number.
limit	int	Results per page.
total	int	Total number of matching accounts.
has_next	bool	Indicates if more pages exist.

Error Response (401 / 403)

{
  "error": "forbidden",
  "message": "You do not have permission to list accounts."
}

Error Code	Meaning
unauthorized	Missing or invalid token.
forbidden	Token does not belong to an admin or platform account.

Example Usage

cURL

curl -X GET "https://api.example.com/v1/accounts?page=1&limit=25&status=active" \
  -H "Authorization: Bearer admin_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/accounts?page=1&limit=25", {
  method: "GET",
  headers: {
    "Authorization": "Bearer admin_access_token"
  }
});

const data = await response.json();
console.log(data.pagination.total);

Use filters like status and created_after to reduce payload size and improve performance when dealing with large datasets.

Close an account

New transaction

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title