Skip to main content
GET
Get Accounts

Authorizations

Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Query Parameters

page
string

The page number 1 - n

limit
string

The number of items per page. Max is 250. Default is 10.

sortKey
enum<string>

The key to sort the items by. Default is _id.

Available options:
_id,
name,
createdAt,
updatedAt,
transactionDate
sortOrder
enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:
1,
-1
query
string

The query to search the accounts by account name

Response

Get Accounts executed successfully

message
string

Success message

metaData
object
data
object