Skip to main content
GET
Fetch Accounts

Overview

This endpoint retrieves a list of accounts with pagination. It fetches a specified number of accounts per page, as per the provided page and limit parameters. You can also filter results by account_number or account_name.

Request

Method: GET
URL: /v1/accounts

Parameters

Response

Status Code: 200 OK
Content-Type: application/json

Example Response

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Query Parameters

page
integer
limit
integer
account_number
string

Filter accounts by a specific account number.

account_name
string

Filter accounts by account name (partial match supported).

customer_id
string

Filter accounts belonging to a specific customer.

Response

200 - application/json

OK

The response is of type object.